AzureAIInferenceChatClient Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.AzureAIInference.dll

Package:

Microsoft.Extensions.AI.AzureAIInference v9.0.0-preview.9.24556.5

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

Object

AzureAIInferenceChatClient

Implements

IChatClient IDisposable

Constructors

AzureAIInferenceChatClient(ChatCompletionsClient, String)

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

Properties

Metadata	Gets metadata that describes the IChatClient.
ToolCallJsonSerializerOptions	Gets or sets JsonSerializerOptions to use for any serialization activities related to tool call arguments and results.

Methods

CompleteAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages to the model and returns the response messages.
CompleteStreamingAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages to the model and streams the response messages.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetService<TService>(Object)	Asks the IChatClient for an object of type TService.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

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

Extension Methods

CompleteAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message to the model and returns the response messages.
CompleteStreamingAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message to the model and streams the response messages.
CompleteAsync<T>(IChatClient, IList<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, IList<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message to the model, requesting a response matching the type T.
CompleteAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message to the model, requesting a response matching the type T.