AzureAIInferenceChatClient Class

Definition

Represents an IChatClient for an Azure AI Inference ChatCompletionsClient.

public ref class AzureAIInferenceChatClient sealed : IDisposable, Microsoft::Extensions::AI::IChatClient
public sealed class AzureAIInferenceChatClient : IDisposable, Microsoft.Extensions.AI.IChatClient
type AzureAIInferenceChatClient = class
    interface IChatClient
    interface IDisposable
Public NotInheritable Class AzureAIInferenceChatClient
Implements IChatClient, IDisposable
Inheritance
AzureAIInferenceChatClient
Implements

Constructors

AzureAIInferenceChatClient(ChatCompletionsClient, String)

Initializes a new instance of the AzureAIInferenceChatClient class for the specified ChatCompletionsClient.

Properties

ToolCallJsonSerializerOptions

Gets or sets JsonSerializerOptions to use for any serialization activities related to tool call arguments and results.

Methods

GetResponseAsync(IList<ChatMessage>, ChatOptions, CancellationToken)

Sends chat messages and returns the response.

GetStreamingResponseAsync(IList<ChatMessage>, ChatOptions, CancellationToken)

Sends chat messages and streams the response.

Explicit Interface Implementations

IChatClient.GetService(Type, Object)

Asks the IChatClient for an object of the specified type serviceType.

IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Extension Methods

AsBuilder(IChatClient)

Creates a new ChatClientBuilder using innerClient as its inner client.

GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Sends a chat message and returns the response messages.

GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Sends a user chat text message and returns the response messages.

GetService<TService>(IChatClient, Object)

Asks the IChatClient for an object of type TService.

GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Sends a chat message and streams the response messages.

GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Sends a user chat text message and streams the response messages.

GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends a chat message, requesting a response matching the type T.

GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends a chat message, requesting a response matching the type T.

GetResponseAsync<T>(IChatClient, IList<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends chat messages, requesting a response matching the type T.

GetResponseAsync<T>(IChatClient, IList<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends chat messages, requesting a response matching the type T.

GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends a user chat text message, requesting a response matching the type T.

GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sends a user chat text message, requesting a response matching the type T.

Applies to