Skip to content

AzureOpenAIConnectionHandler

Description: Automatically infers the values from environment variables for: - api_key from AZURE_OPENAI_API_KEY (IFF api_key AND ‘azure_ad_token_provider’ is not provided) - organization from OPENAI_ORG_ID - azure_ad_token from AZURE_OPENAI_AD_TOKEN - api_version from OPENAI_API_VERSION - azure_endpoint from AZURE_OPENAI_ENDPOINT

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ implementationNoconstNo-Implementation
- azure_ad_token_providerNoobjectNoIn #/$defs/_Reference-
- token_provider_scopesNoarray of stringNo-Token Provider Scopes
- api_versionNostringNo-Api Version
- NoobjectNo--

1. Property implementation

Title: Implementation

Typeconst
RequiredYes

Specific value: "AzureOpenAIConnectionHandler"

2. Property azure_ad_token_provider

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/_Reference
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- implementationNostringNo-Implementation
- NoobjectNo--

2.1. Property implementation

Title: Implementation

Typestring
RequiredNo

3. Property token_provider_scopes

Title: Token Provider Scopes

Typearray of string
RequiredNo
Default["https://cognitiveservices.azure.com/.default"]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
token_provider_scopes items-

3.1. token_provider_scopes items

Typestring
RequiredNo

4. Property api_version

Title: Api Version

Typestring
RequiredNo
Default"2024-02-01"