AzureAIInferenceChatCompletionService Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.AzureAIInference

Assembly:: Microsoft.SemanticKernel.Connectors.AzureAIInference.dll

Package:: Microsoft.SemanticKernel.Connectors.AzureAIInference v1.45.0-beta

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.

Caution

Dedicated AzureAIInferenceChatCompletionService is deprecated. Use Azure.AI.Inference.ChatCompletionsClient.AsChatClient().AsChatCompletionService() instead.

Chat completion service for Azure AI Inference.

[System.Obsolete("Dedicated AzureAIInferenceChatCompletionService is deprecated. Use Azure.AI.Inference.ChatCompletionsClient.AsChatClient().AsChatCompletionService() instead.")]
public sealed class AzureAIInferenceChatCompletionService : Microsoft.SemanticKernel.ChatCompletion.IChatCompletionService

[<System.Obsolete("Dedicated AzureAIInferenceChatCompletionService is deprecated. Use Azure.AI.Inference.ChatCompletionsClient.AsChatClient().AsChatCompletionService() instead.")>]
type AzureAIInferenceChatCompletionService = class
    interface IChatCompletionService
    interface IAIService

Public NotInheritable Class AzureAIInferenceChatCompletionService
Implements IChatCompletionService

Inheritance: Object
AzureAIInferenceChatCompletionService

Attributes: ObsoleteAttribute

Implements: IChatCompletionService IAIService

Constructors

Name	Description
AzureAIInferenceChatCompletionService(String, ChatCompletionsClient, ILoggerFactory)	Initializes a new instance of the AzureAIInferenceChatCompletionService class providing your own ChatCompletionsClient instance.
AzureAIInferenceChatCompletionService(String, String, Uri, HttpClient, ILoggerFactory)	Initializes a new instance of the AzureAIInferenceChatCompletionService class.
AzureAIInferenceChatCompletionService(String, TokenCredential, Uri, HttpClient, ILoggerFactory)	Initializes a new instance of the AzureAIInferenceChatCompletionService class.

Properties

Name	Description
Attributes	Gets the AI service attributes.

Methods

Name	Description
GetChatMessageContentsAsync(ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get chat multiple chat content choices for the prompt and settings.
GetStreamingChatMessageContentsAsync(ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get streaming chat contents for the chat history provided using the specified settings.

Extension Methods

Name	Description
AsChatClient(IChatCompletionService)	Creates an IChatClient for the specified IChatCompletionService.
GetApiVersion(IAIService)	Gets the API version from `service`'s Attributes
GetChatMessageContentAsync(IChatCompletionService, ChatHistory, PromptExecutionSettings, Kernel, CancellationToken)	Get a single chat message content for the chat history and settings provided.
GetChatMessageContentAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get a single chat message content for the prompt and settings.
GetChatMessageContentsAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get chat multiple chat message content choices for the prompt and settings.
GetEndpoint(IAIService)	Gets the endpoint from `service`'s Attributes.
GetModelId(IAIService)	Gets the model identifier from `service`'s Attributes.
GetStreamingChatMessageContentsAsync(IChatCompletionService, String, PromptExecutionSettings, Kernel, CancellationToken)	Get streaming chat message contents for the chat history provided using the specified settings.

Applies to