ConfigureOptionsChatClient Class

Definition

public ref class ConfigureOptionsChatClient sealed : Microsoft::Extensions::AI::DelegatingChatClient

public sealed class ConfigureOptionsChatClient : Microsoft.Extensions.AI.DelegatingChatClient

type ConfigureOptionsChatClient = class
    inherit DelegatingChatClient

Public NotInheritable Class ConfigureOptionsChatClient
Inherits DelegatingChatClient

Inheritance

Object

DelegatingChatClient

ConfigureOptionsChatClient

Remarks

The configuration callback is invoked with the caller-supplied ChatOptions instance. To override the caller-supplied options with a new instance, the callback may simply return that new instance, for example _ => new ChatOptions() { MaxTokens = 1000 }. To provide a new instance only if the caller-supplied instance is null, the callback may conditionally return a new instance, for example options => options ?? new ChatOptions() { MaxTokens = 1000 }. Any changes to the caller-provided options instance will persist on the original instance, so the callback must take care to only do so when such mutations are acceptable, such as by cloning the original instance and mutating the clone, for example: options => { var newOptions = options?.Clone() ?? new(); newOptions.MaxTokens = 1000; return newOptions; }

The callback may return null, in which case a null options will be passed to the next client in the pipeline.

The provided implementation of IChatClient is thread-safe for concurrent use so long as the employed configuration callback is also thread-safe for concurrent requests. If callers employ a shared options instance, care should be taken in the configuration callback, as multiple calls to it may end up running in parallel with the same options instance.

Constructors

Properties

Methods

Extension Methods

Applies to