Azure OpenAI

Overview

Azure OpenAI Service is a cloud-based platform that provides access to advanced AI models developed by OpenAI, integrated with Microsoft's Azure infrastructure. This plugin allows users to leverage cutting-edge generative AI capabilities such as LLMs, text embedding, speech-to-text (STT), and text-to-speech (TTS) for various applications, ensuring security and compliance through Azure's robust framework.

Configure

Once the plugin is installed, configure your Azure OpenAI Service Model by providing the Model Type, Deployment Name, API Endpoint URL, Authentication Method, and the Base Model. The API Version is optional when your endpoint already uses the Azure OpenAI v1 path, for example https://<resource>.openai.azure.com/openai/v1/.

Web Search (Azure native)

This plugin supports Azure OpenAI native Web Search for models that use the Responses API path in this provider.

Available model parameters:

• Enable Web Search (enable_web_search): Enables tools: [{"type": "web_search"}].
• Web Search Country (web_search_user_country): Optional ISO 3166-1 alpha-2 country code (for example, US, JP).
• Allowed Domains (web_search_allowed_domains): Optional allowlist of domains (comma/newline-separated).
• Include Source Metadata (web_search_include_sources): Optional opt-in flag to request include=["web_search_call.action.sources"].

Notes:

• Web Search is controlled by Azure subscription settings and can be blocked by admins.
• Grounding with Bing terms, privacy, and pricing apply.
• If your endpoint/API version does not support Web Search for the selected model, Azure will return an API error.

Authentication Methods

This plugin supports two authentication methods:

1. API Key Authentication (Default)

• Select "API Key" as the authentication method
• Provide your Azure OpenAI API Key
• Find your API key in Azure Portal

2. Microsoft Entra ID (Service Principal)

• Select "Microsoft Entra ID (Service Principal)" as the authentication method
• No API Key is required - uses Azure Active Directory for authentication
• Provide the following credentials from your Azure AD App Registration:
  • Application (Client) ID: Your Azure AD application client ID
  • Directory (Tenant) ID: Your Azure AD tenant ID
  • Client Secret Value: Your Azure AD application client secret value (not the Secret ID)
• Each user/workspace can have different credentials
• Enhanced security with centralized identity management
• Suitable for production environments and automated workflows

Prerequisites:

1. Create an App Registration in Azure AD (Azure Portal → Azure Active Directory → App registrations → New registration)
2. Generate a client secret for the application (Certificates & secrets → New client secret)
3. Copy the Value (not the Secret ID) when the secret is created
4. Assign the "Cognitive Services User" role to the Service Principal on your Azure AI Services resource:
   • Go to your Azure AI Services resource
   • Access Control (IAM) → Add role assignment
   • Select "Cognitive Services User" role
   • Assign to your App Registration
5. Wait up to 5 minutes for role assignment to propagate

Note: The credentials you enter are specific to your configuration and are not shared with other users.

Reference: Configure Microsoft Entra ID for Azure OpenAI