OpenAIChatClient Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

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

Package:: Microsoft.Extensions.AI.OpenAI v9.3.0-preview.1.25114.11

Source:: OpenAIChatClient.cs

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.

Represents an IChatClient for an OpenAI OpenAIClient or 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 ChatClient.
OpenAIChatClient(OpenAIClient, String)	Initializes a new instance of the OpenAIChatClient class for the specified OpenAIClient.

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

通过