IChatClient Interface (Microsoft.Extensions.AI) (original) (raw)

Definition

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.

Represents a chat client.

public interface class IChatClient : IDisposable

public interface IChatClient : IDisposable

type IChatClient = interface
    interface IDisposable

Public Interface IChatClient
Implements IDisposable

Derived

Implements

Remarks

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 IChatClient implementation explicitly documents safeguards for these concerns, the application is expected to implement appropriate protections.

Unless otherwise specified, all members of IChatClient are thread-safe for concurrent use. It is expected that all implementations of IChatClient support being used by multiple requests concurrently. Instances must not be disposed of while the instance is still in use.

However, implementations of IChatClient might mutate the arguments supplied to GetResponseAsync(IEnumerable, ChatOptions, CancellationToken) and GetStreamingResponseAsync(IEnumerable, ChatOptions, CancellationToken), such as by configuring the options instance. Thus, consumers of the interface either should avoid using shared instances of these arguments for concurrent invocations or should otherwise ensure by construction that no IChatClient instances are used which might employ such mutation. For example, the ConfigureOptions method is provided with a callback that could mutate the supplied options argument, and that should be avoided if using a singleton options instance.

Methods

Extension Methods

Applies to

See also

• Build an AI chat app with .NET.
• The IChatClient interface.