Models
Azure OpenAI
Models
Azure OpenAI
Use the best in class GPT models using Azure’s OpenAI API. Learn more here.
At the moment we only support OpenAI models via Azure.
Authentication
Navigate to the AzureOpenAI on the Azure Portal and create a service. Then, using the Azure AI Foundry portal, create a deployment and set your environment variables.
Example
Use AzureOpenAI with your Agent:
View more examples here.
Params
| Parameter | Type | Default | Description |
|---|---|---|---|
id | str | - | The specific model ID used for generating responses. This field is required. |
name | str | "AzureOpenAI" | The name identifier for the agent. |
provider | str | "Azure" | The provider of the model. |
api_key | Optional[str] | "None" | The API key for authenticating requests to the Azure OpenAI service. |
api_version | str | "2024-10-21" | The version of the Azure OpenAI API to use. |
azure_endpoint | Optional[str] | "None" | The endpoint URL for the Azure OpenAI service. |
azure_deployment | Optional[str] | "None" | The deployment name or ID in Azure. |
azure_ad_token | Optional[str] | "None" | The Azure Active Directory token for authenticating requests. |
azure_ad_token_provider | Optional[Any] | "None" | The provider for obtaining Azure Active Directory tokens. |
openai_client | Optional[AzureOpenAIClient] | "None" | An instance of AzureOpenAIClient provided for making API requests. |
AzureOpenAI also supports the params of OpenAI.