DelegatingChatClient class abstract

Provides an optional base class for an ChatClient that passes through calls to another instance.

This is recommended as a base type when building clients that can be chained around an underlying ChatClient. The default implementation simply passes each call to the inner client instance.

Implemented types

• ChatClient

Implementers

• AnonymousDelegatingChatClient
• CachingChatClient
• ConfigureOptionsChatClient
• FunctionInvokingChatClient
• ImageGeneratingChatClient
• LoggingChatClient
• OpenTelemetryChatClient
• ReducingChatClient

Available extensions

• ChatClientExtensions

Constructors

DelegatingChatClient(ChatClient innerClient)

Initializes a new instance of the DelegatingChatClient class.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

innerClient → ChatClient

The inner client to delegate to.

final

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.

override

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.

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

Sends a chat request and returns the complete response.

override

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

Gets a service of the specified type.

override

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.

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

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

override

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