AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.AzureOpenAI v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AddAzureOpenAIChatCompletion(IKernelBuilder, String, AzureOpenAIClient, String, String)	Adds the AzureOpenAIChatCompletionService to the Services.
AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient)	Adds the AzureOpenAIChatCompletionService to the Services.
AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, String, String, String, HttpClient)	Adds the AzureOpenAIChatCompletionService to the Services.

AddAzureOpenAIChatCompletion(IKernelBuilder, String, AzureOpenAIClient, String, String)

Adds the AzureOpenAIChatCompletionService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, Azure.AI.OpenAI.AzureOpenAIClient? azureOpenAIClient = default, string? serviceId = default, string? modelId = default);

static member AddAzureOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * Azure.AI.OpenAI.AzureOpenAIClient * string * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAIChatCompletion (builder As IKernelBuilder, deploymentName As String, Optional azureOpenAIClient As AzureOpenAIClient = Nothing, Optional serviceId As String = Nothing, Optional modelId As String = Nothing) As IKernelBuilder

Parameters

builder: IKernelBuilder

The IKernelBuilder instance to augment.

deploymentName: String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

azureOpenAIClient: AzureOpenAIClient

AzureOpenAIClient to use for the service. If null, one must be available in the service provider when this service is resolved.

serviceId: String

A local identifier for the given AI service

modelId: String

Model identifier, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

Returns

IKernelBuilder

The same instance as builder.

Applies to

AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient)

Adds the AzureOpenAIChatCompletionService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, string endpoint, Azure.Core.TokenCredential credentials, string? serviceId = default, string? modelId = default, System.Net.Http.HttpClient? httpClient = default);

static member AddAzureOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * string * Azure.Core.TokenCredential * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAIChatCompletion (builder As IKernelBuilder, deploymentName As String, endpoint As String, credentials As TokenCredential, Optional serviceId As String = Nothing, Optional modelId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilder

Parameters

builder: IKernelBuilder

The IKernelBuilder instance to augment.

deploymentName: String

Azure OpenAI deployment name, see https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource

endpoint: String

Azure OpenAI deployment URL, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

credentials: TokenCredential

Token credentials, e.g. DefaultAzureCredential, ManagedIdentityCredential, EnvironmentCredential, etc.

serviceId: String

A local identifier for the given AI service

modelId: String

Model identifier, see https://learn.microsoft.com/azure/cognitive-services/openai/quickstart

httpClient: HttpClient

The HttpClient to use with this service.

Returns

IKernelBuilder

The same instance as builder.

Applies to

AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, String, String, String, HttpClient)

Adds the AzureOpenAIChatCompletionService to the Services.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureOpenAIChatCompletion (this Microsoft.SemanticKernel.IKernelBuilder builder, string deploymentName, string endpoint, string apiKey, string? serviceId = default, string? modelId = default, System.Net.Http.HttpClient? httpClient = default);

static member AddAzureOpenAIChatCompletion : Microsoft.SemanticKernel.IKernelBuilder * string * string * string * string * string * System.Net.Http.HttpClient -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureOpenAIChatCompletion (builder As IKernelBuilder, deploymentName As String, endpoint As String, apiKey As String, Optional serviceId As String = Nothing, Optional modelId As String = Nothing, Optional httpClient As HttpClient = Nothing) As IKernelBuilder