GPT-4o
, gpt-5-mini
, and more.
Authentication
Navigate to Azure OpenAI on the Azure Portal and create a service. Then, using the Azure AI Studio portal, create a deployment and set your environment variables:Example
UseAzureOpenAI
with your Agent
:
Prompt caching
Prompt caching will happen automatically using ourAzureOpenAI
model. You can read more about how OpenAI handle caching in their docs.
Advanced Examples
View more examples here.Parameters
Parameter | Type | Default | Description |
---|---|---|---|
id | str | (required) | The deployment name or model name to use |
name | str | "AzureOpenAI" | The name of the model |
provider | str | "Azure" | The provider of the model |
api_key | Optional[str] | None | The API key for Azure OpenAI (defaults to AZURE_OPENAI_API_KEY env var) |
api_version | Optional[str] | "2024-10-21" | The API version to use |
azure_endpoint | Optional[str] | None | The Azure endpoint URL (defaults to AZURE_OPENAI_ENDPOINT env var) |
azure_deployment | Optional[str] | None | The deployment name (defaults to AZURE_OPENAI_DEPLOYMENT env var) |
base_url | Optional[str] | None | Alternative base URL for the service |
azure_ad_token | Optional[str] | None | Azure AD token for authentication |
azure_ad_token_provider | Optional[Any] | None | Azure AD token provider for authentication |
default_headers | Optional[Dict[str, str]] | None | Default headers to include in all requests |
default_query | Optional[Dict[str, Any]] | None | Default query parameters to include in all requests |
AzureOpenAI
also supports the parameters of OpenAI.