AzureOpenAIClientOptions interface

Package:

@azure/ai-projects

The options for configuring the Azure OpenAI client.

Properties

apiVersion	The Azure OpenAI api-version to use when creating the client. See "Data plane - Inference" row in the table at https://learn.microsoft.com/azure/ai-foundry/openai/reference#api-specs. If not provided, you must set the environment variable OPENAI_API_VERSION instead.
connectionName	The name of a connection to an Azure OpenAI resource in your AI Foundry project. If not provided, the default Azure OpenAI connection will be used.
connectionOptions	The connection options to use for the Azure OpenAI connection.
connectionSecretOptions	The connection secret options to use for the Azure OpenAI client.

Property Details

apiVersion

The Azure OpenAI api-version to use when creating the client. See "Data plane - Inference" row in the table at https://learn.microsoft.com/azure/ai-foundry/openai/reference#api-specs. If not provided, you must set the environment variable OPENAI_API_VERSION instead.

apiVersion?: string

Property Value

string

connectionName

The name of a connection to an Azure OpenAI resource in your AI Foundry project. If not provided, the default Azure OpenAI connection will be used.

connectionName?: string

Property Value

string

connectionOptions

The connection options to use for the Azure OpenAI connection.

connectionOptions?: ConnectionsGetOptionalParams

Property Value

ConnectionsGetOptionalParams

connectionSecretOptions

The connection secret options to use for the Azure OpenAI client.

connectionSecretOptions?: ConnectionsGetWithCredentialsOptionalParams

Property Value

ConnectionsGetWithCredentialsOptionalParams