Share via

ChatClientBuilder Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.dll
Package:
Microsoft.Extensions.AI v10.0.0
Source:
ChatClientBuilder.cs

A builder for creating pipelines of IChatClient.

public ref class ChatClientBuilder sealed
public sealed class ChatClientBuilder
type ChatClientBuilder = class
Public NotInheritable Class ChatClientBuilder
Inheritance
Object
ChatClientBuilder

Constructors

ChatClientBuilder(Func<IServiceProvider,IChatClient>)

Initializes a new instance of the ChatClientBuilder class.
ChatClientBuilder(IChatClient)

Initializes a new instance of the ChatClientBuilder class.

Methods

Build(IServiceProvider)

Builds an IChatClient that represents the entire pipeline. Calls to this instance will pass through each of the pipeline stages in turn.
Use(Func<IChatClient,IChatClient>)

Adds a factory for an intermediate chat client to the chat client pipeline.
Use(Func<IChatClient,IServiceProvider,IChatClient>)

Adds a factory for an intermediate chat client to the chat client pipeline.
Use(Func<IEnumerable<ChatMessage>,ChatOptions,Func<IEnumerable<ChatMessage>,ChatOptions,CancellationToken,Task>,CancellationToken,Task>)

Adds to the chat client pipeline an anonymous delegating chat client based on a delegate that provides an implementation for both GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) and GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken).
Use(Func<IEnumerable<ChatMessage>,ChatOptions,IChatClient,CancellationToken, Task<ChatResponse>>, Func<IEnumerable<ChatMessage>,ChatOptions, IChatClient,CancellationToken,IAsyncEnumerable<ChatResponseUpdate>>)

Adds to the chat client pipeline an anonymous delegating chat client based on a delegate that provides an implementation for both GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) and GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken).

Extension Methods

UseToolReduction(ChatClientBuilder, IToolReductionStrategy)

Adds tool reduction to the chat client pipeline using the specified strategy.
ConfigureOptions(ChatClientBuilder, Action<ChatOptions>)

Adds a callback that configures a ChatOptions to be passed to the next client in the pipeline.
UseDistributedCache(ChatClientBuilder, IDistributedCache, Action<DistributedCachingChatClient>)

Adds a DistributedCachingChatClient as the next stage in the pipeline.
UseFunctionInvocation(ChatClientBuilder, ILoggerFactory, Action<FunctionInvokingChatClient>)

Enables automatic function call invocation on the chat pipeline.
UseImageGeneration(ChatClientBuilder, IImageGenerator, Action<ImageGeneratingChatClient>)

Adds image generation capabilities to the chat client pipeline.
UseLogging(ChatClientBuilder, ILoggerFactory, Action<LoggingChatClient>)

Adds logging to the chat client pipeline.
UseOpenTelemetry(ChatClientBuilder, ILoggerFactory, String, Action<OpenTelemetryChatClient>)

Adds OpenTelemetry support to the chat client pipeline, following the OpenTelemetry Semantic Conventions for Generative AI systems.
UseChatReducer(ChatClientBuilder, IChatReducer, Action<ReducingChatClient>)

Adds a ReducingChatClient to the chat pipeline.

Applies to