IChatClient Rozhraní

Definice

Obor názvů:
Microsoft.Extensions.AI
Sestavení:
Microsoft.Extensions.AI.Abstractions.dll
Balíček:
Microsoft.Extensions.AI.Abstractions v10.7.0
Zdroj:
IChatClient.cs

Představuje chatovacího klienta.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Odvozené
Implementuje
IDisposable

Poznámky

Aplikace musí zvážit rizika, jako jsou útoky prostřednictvím injektáže výzvy, velikosti dat a počet zpráv odeslaných podkladovému poskytovateli nebo vrácených z těchto aplikací. Pokud konkrétní IChatClient implementace explicitně dokumentuje záruky těchto obav, očekává se, že aplikace implementuje odpovídající ochranu.

Pokud neurčíte jinak, jsou všichni členové IChatClient pro souběžné použití bezpečné pro přístup z více vláken. Očekává se, že souběžně používají všechny implementace IChatClient podpory více požadavků. Instance nesmí být uvolněny, zatímco instance je stále používána.

Implementace však mohou ztlumit argumenty IChatClient zadané do GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) a GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken), například konfigurací instance možností. Spotřebitelé rozhraní by se proto neměli používat sdílené instance těchto argumentů pro souběžné vyvolání, nebo by jinak měli zajistit, aby se nevyužívaly žádné IChatClient instance, které by mohly takové inmutace využívat. Například Metoda ConfigureOptions je poskytována se zpětným voláním, který by mohl ztlumit zadaný argument možnosti a které by se měly vyhnout, pokud používáte instanci s jednímtonem možností.

Metody

Name Description
Dispose()

Provádí úlohy definované aplikací související s uvolněním, uvolněním nebo resetováním nespravovaných prostředků.

(Zděděno od IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Odešle chatové zprávy a vrátí odpověď.
GetService(Type, Object)

Požádá o IChatClient objekt zadaného typu serviceType.
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Odešle chatové zprávy a streamuje odpověď.

Metody rozšíření

Name Description
AsBuilder(IChatClient)

Vytvoří nové ChatClientBuilder použití innerClient jako jeho vnitřní klient.
GetRequiredService(IChatClient, Type, Object)

IChatClient Požádá o objekt zadaného typu serviceType a vyvolá výjimku, pokud není k dispozici.
GetRequiredService<TService>(IChatClient, Object)

IChatClient Požádá o objekt typu TService a vyvolá výjimku, pokud není k dispozici.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Odešle chatovou zprávu a vrátí zprávy s odpovědí.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Odešle textovou zprávu chatu uživatele a vrátí zprávy s odpovědí.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Odešle chatovou zprávu a požádá o odpověď odpovídající typu T.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Odešle chatovou zprávu a požádá o odpověď odpovídající typu T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Odesílá chatové zprávy a žádá o odpověď odpovídající typu T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Odesílá chatové zprávy a žádá o odpověď odpovídající typu T.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Odešle textovou zprávu chatu uživatele s žádostí o odpověď odpovídající typu T.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Odešle textovou zprávu chatu uživatele s žádostí o odpověď odpovídající typu T.
GetService<TService>(IChatClient, Object)

Požádá o IChatClient objekt typu TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Odešle chatovou zprávu a streamuje zprávy s odpověďmi.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Odešle textovou zprávu chatu uživatele a streamuje zprávy odpovědí.

Platí pro

Viz také