interface AzureClientOptions
extends ClientOptions
API Client for interfacing with the Azure OpenAI API.
Properties
optional
apiVersion: string | undefinedDefaults to process.env['OPENAI_API_VERSION'].
Your Azure endpoint, including the resource, e.g. https://example-resource.azure.openai.com/
optional
deployment: string | undefinedA model deployment, if given, sets the base client URL to include /deployments/{deployment}.
Note: this means you won't be able to use non-deployment endpoints. Not supported with Assistants APIs.
optional
azureADTokenProvider: (() => Promise<string>) | undefinedA function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.