DelegatingChatClient Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.0.0-preview.9.24556.5

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.

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

public ref class DelegatingChatClient : IDisposable, Microsoft::Extensions::AI::IChatClient

public class DelegatingChatClient : IDisposable, Microsoft.Extensions.AI.IChatClient

type DelegatingChatClient = class
    interface IChatClient
    interface IDisposable

Public Class DelegatingChatClient
Implements IChatClient, IDisposable

Inheritance: Object
DelegatingChatClient

Derived: Microsoft.Extensions.AI.CachingChatClient

Microsoft.Extensions.AI.ConfigureOptionsChatClient

Microsoft.Extensions.AI.FunctionInvokingChatClient

Microsoft.Extensions.AI.LoggingChatClient

Microsoft.Extensions.AI.OpenTelemetryChatClient

Implements: IChatClient IDisposable

Remarks

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

Constructors

DelegatingChatClient(IChatClient)

Initializes a new instance of the DelegatingChatClient class.

Properties

InnerClient	Gets the inner IChatClient.
Metadata	Gets metadata that describes the IChatClient.

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.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)	Provides a mechanism for releasing unmanaged resources.
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)

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

Partager via