The AzureOpenAI model provides access to Azure-hosted OpenAI models.

ParameterTypeDefaultDescription
idstr-The specific model ID used for generating responses. This field is required.
namestr"AzureOpenAI"The name identifier for the agent.
providerstr"Azure"The provider of the model.
api_keyOptional[str]"None"The API key for authenticating requests to the Azure OpenAI service.
api_versionstr"2024-10-21"The version of the Azure OpenAI API to use.
azure_endpointOptional[str]"None"The endpoint URL for the Azure OpenAI service.
azure_deploymentOptional[str]"None"The deployment name or ID in Azure.
azure_ad_tokenOptional[str]"None"The Azure Active Directory token for authenticating requests.
azure_ad_token_providerOptional[Any]"None"The provider for obtaining Azure Active Directory tokens.
openai_clientOptional[AzureOpenAIClient]"None"An instance of AzureOpenAIClient provided for making API requests.