AzureOpenAIProvider

Namespace: Vercel.AI.Azure

public sealed class AzureOpenAIProvider : OpenAICompatibleProvider

Azure OpenAI provider. Calls use the /openai/v1 routes and the api-key header, or the deployments routes when UseDeploymentBasedUrls is set.

Inheritance: object → ProviderBase → OpenAICompatibleProvider

View source

Constructors

AzureOpenAIProvider(HttpClient, AzureOpenAIOptions?)

public AzureOpenAIProvider(HttpClient httpClient, AzureOpenAIOptions? options = null)

Creates a provider.

Parameters

Name	Type	Description
httpClient	HttpClient
options	AzureOpenAIOptions

View source

Fields

ProviderId

public const string ProviderId = "azure"

Provider id.

Value: string

View source

Methods

ChatModel(string, AzureOpenAILanguageModelSettings?)

public OpenAIChatLanguageModel ChatModel(string deploymentId, AzureOpenAILanguageModelSettings? settings)

Chat model for a deployment. The optional model ID is used for reported identity and capability detection; requests always use the deployment ID.

Parameters

Name	Type	Description
deploymentId	string
settings	AzureOpenAILanguageModelSettings

Returns: OpenAIChatLanguageModel

View source

CompletionModel(string, AzureOpenAILanguageModelSettings?)

public OpenAICompatibleCompletionLanguageModel CompletionModel(string deploymentId, AzureOpenAILanguageModelSettings? settings)

Completion model for a deployment. The optional model ID is used for reported identity; requests always use the deployment ID.

Parameters

Name	Type	Description
deploymentId	string
settings	AzureOpenAILanguageModelSettings

Returns: OpenAICompatibleCompletionLanguageModel

View source

Create(AzureOpenAIOptions?, HttpMessageHandler?)

public static AzureOpenAIProvider Create(AzureOpenAIOptions? options = null, HttpMessageHandler? handler = null)

Creates a provider.

Parameters

Name	Type	Description
options	AzureOpenAIOptions
handler	HttpMessageHandler

Returns: AzureOpenAIProvider

View source

LanguageModel(string)

public override ILanguageModel LanguageModel(string modelId)

Returns a language model.

Parameters

Name	Type	Description
modelId	string

Returns: ILanguageModel

View source

LanguageModel(string, AzureOpenAILanguageModelSettings?)

public OpenAIResponsesLanguageModel LanguageModel(string deploymentId, AzureOpenAILanguageModelSettings? settings)

Responses API model, like ResponsesModel(string). The optional model ID in <code class=“paramref”>settings</code> is used for reported identity and capability detection.

Parameters

Name	Type	Description
deploymentId	string
settings	AzureOpenAILanguageModelSettings

Returns: OpenAIResponsesLanguageModel

View source

ResponsesModel(string)

public OpenAIResponsesLanguageModel ResponsesModel(string modelId)

Responses API model. The provider id is azure.responses. Options are read from the azure provider options and fall back to openai.

Parameters

Name	Type	Description
modelId	string

Returns: OpenAIResponsesLanguageModel

View source

ResponsesModel(string, AzureOpenAILanguageModelSettings?)

public OpenAIResponsesLanguageModel ResponsesModel(string deploymentId, AzureOpenAILanguageModelSettings? settings)

Responses API model for a deployment. The optional model ID is used for reported identity and capability detection; requests always use the deployment ID.

Parameters

Name	Type	Description
deploymentId	string
settings	AzureOpenAILanguageModelSettings

Returns: OpenAIResponsesLanguageModel

View source