OpenAIChatClient Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.OpenAI.dll

Package:: Microsoft.Extensions.AI.OpenAI v9.0.0-preview.9.24525.1

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.

An IChatClient for an OpenAI OpenAI.OpenAIClient or OpenAI.Chat.ChatClient.

public ref class OpenAIChatClient sealed : IDisposable, Microsoft::Extensions::AI::IChatClient

public sealed class OpenAIChatClient : IDisposable, Microsoft.Extensions.AI.IChatClient

type OpenAIChatClient = class
    interface IChatClient
    interface IDisposable

Public NotInheritable Class OpenAIChatClient
Implements IChatClient, IDisposable

Inheritance: Object
OpenAIChatClient

Implements: IChatClient IDisposable

Constructors

OpenAIChatClient(ChatClient)	Initializes a new instance of the OpenAIChatClient class for the specified OpenAI.Chat.ChatClient.
OpenAIChatClient(OpenAIClient, String)	Initializes a new instance of the OpenAIChatClient class for the specified OpenAI.OpenAIClient.

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`.

Applies to

Share via