ChatClient class abstract

Represents a chat client.

Applications must consider risks such as prompt injection attacks, data sizes, and the number of messages sent to the underlying provider or returned from it. Unless a specific ChatClient implementation explicitly documents safeguards for these concerns, the application is expected to implement appropriate protections.

Implemented types

• Disposable

Implementers

• DelegatingChatClient

Available extensions

• ChatClientExtensions

Constructors

ChatClient()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

dispose() → void

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

inherited

getChatResponse({required Iterable<ChatMessage> messages, ChatOptions? options, CancellationToken? cancellationToken}) → Future<ChatResponse>

Sends a chat request and returns the complete response.

getChatResponseFromMessage(ChatMessage message, {ChatOptions? options, CancellationToken? cancellationToken}) → Future<ChatResponse>

Available on ChatClient, provided by the ChatClientExtensions extension

Sends a single message and returns the response.

getChatResponseFromText(String message, {ChatOptions? options, CancellationToken? cancellationToken}) → Future<ChatResponse>

Available on ChatClient, provided by the ChatClientExtensions extension

Sends a single user text message and returns the response.

getService<T>({Object? key}) → T?

Gets a service of the specified type.

getStreamingChatResponse({required Iterable<ChatMessage> messages, ChatOptions? options, CancellationToken? cancellationToken}) → Stream<ChatResponseUpdate>

Sends a chat request and returns a stream of response updates.

getStreamingChatResponseFromMessage(ChatMessage message, {ChatOptions? options, CancellationToken? cancellationToken}) → Stream<ChatResponseUpdate>

Available on ChatClient, provided by the ChatClientExtensions extension

Sends a single message and returns a streaming response.

getStreamingChatResponseFromText(String message, {ChatOptions? options, CancellationToken? cancellationToken}) → Stream<ChatResponseUpdate>

Available on ChatClient, provided by the ChatClientExtensions extension

Sends a single user text message and returns a streaming response.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited