Edit Azure Open AI page #12354
Merged
Edit Azure Open AI page #12354
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
alaudazzi added documentation 
🚀 Benchmarks reportTo see the full report comment with |
Member
| Here are some suggestions. Rest looks good! diff --git a/packages/azure_openai/_dev/build/docs/README.md b/packages/azure_openai/_dev/build/docs/README.md index 60a879c37d..7bbf02809d 100644 --- a/packages/azure_openai/_dev/build/docs/README.md +++ b/packages/azure_openai/_dev/build/docs/README.md @@ -1,6 +1,6 @@ # Azure OpenAI Integration -The Azure OpenAI service provides flexibility to build your own copilot and AI applications. The Azure OpenAI integration collects metrics and logs through [azure-monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/metrics-index) and Azure [event hub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs) respectively. +The Azure OpenAI service provides flexibility to build your own copilot and AI applications. The Azure OpenAI integration collects metrics and logs through [azure-monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/metrics-index) and the Azure [event hub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs) respectively. To fully populate the Azure OpenAI dashboard lenses, you have to enable both logs and metrics data streams and set up the Azure Billing integration in advance. @@ -25,15 +25,15 @@ Refer to the [Azure Logs](https://docs.elastic.co/integrations/azure) page for m #### Default Logging -The Azure OpenAI provides native logging and monitoring with which you can track the telemetry of the service. The Audit and RequestResponse log categories come under the native logging. However, the default logging doesn't log the inputs and outputs of the service. This is useful to ensure that the services operates as expected. +The Azure OpenAI provides native logging and monitoring to track the telemetry of the service. The Audit and RequestResponse log categories come under the native logging. However, the default logging doesn't log the inputs and outputs of the service. This is useful to ensure that the service operates as expected. The logs collected using the default cognitive services are listed on the [Monitor OpenAI models](https://learn.microsoft.com/en-us/azure/architecture/ai-ml/openai/architecture/log-monitor-azure-openai#:~:text=Metric-,Default%20Azure%20OpenAI%20logging,-This%20solution) page. #### Advance Logging -The API Management services provide the advance logging capabilities. The `ApiManagementGatewayLogs` category comes under the advance logging. This is not directly available in the Azure OpenAI service itself. You have to set up the API Management services in the Azure to access the Azure OpenAI. When the setup is complete, add the diagnostic setting for the API Management service. +The API Management services provide the advanced logging capabilities. The `ApiManagementGatewayLogs` category comes under the advanced logging. This is not directly available in the Azure OpenAI service itself. You have to set up the API Management services in Azure to access the Azure OpenAI. When the setup is complete, add the diagnostic setting for the API Management service. -For more information on how to implement the comprehensive solution using API Management services to monitor the Azure OpenAI services, check the [Monitor OpenAI models](https://learn.microsoft.com/en-us/azure/architecture/ai-ml/openai/architecture/log-monitor-azure-openai) page. +For more information on how to implement the comprehensive solution using API Management services to monitor the Azure OpenAI services, check the [Monitor OpenAI models](https://learn.microsoft.com/en-us/azure/architecture/ai-ml/openai/architecture/log-monitor-azure-openai) page. **Diagnostic settings** |
andrewkroh added Integration:azure_openai 
💚 Build Succeeded
History
cc @alaudazzi |
|
shmsr approved these changes Jan 16, 2025
| Package azure_openai - 1.4.2 containing this change is available at https://epr.elastic.co/package/azure_openai/1.4.2/ |
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 4, 2025
* Editing pass * Integrate reviewer's comments * Update changelog and manifest
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 5, 2025
* Editing pass * Integrate reviewer's comments * Update changelog and manifest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This PR proposes some editing suggestions.
Closes https://github.com/elastic/integration-docs/issues/626
CC @daniela-elastic