IChatClient Schnittstelle

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Paket:
Microsoft.Extensions.AI.Abstractions v10.6.0
Quelle:
IChatClient.cs

Stellt einen Chatclient dar.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Abgeleitet
Implementiert
IDisposable

Hinweise

Anwendungen müssen Risiken berücksichtigen, z. B. Eingabeaufforderungsangriffe, Datengrößen und die Anzahl der Nachrichten, die an den zugrunde liegenden Anbieter gesendet oder von ihm zurückgegeben werden. Sofern eine bestimmte IChatClient Implementierung keine expliziten Garantien für diese Bedenken dokumentiert, wird erwartet, dass die Anwendung geeignete Schutzmaßnahmen implementiert.

Sofern nicht anders angegeben, sind alle Member IChatClient threadsicher für die gleichzeitige Verwendung. Es wird erwartet, dass alle Implementierungen der IChatClient Unterstützung von mehreren Anforderungen gleichzeitig verwendet werden. Instanzen dürfen nicht verworfen werden, während die Instanz noch verwendet wird.

Implementierungen von IChatClient Argumenten können jedoch die bereitgestellten GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) Argumente stummschalten, GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)z. B. durch Konfigurieren der Optionsinstanz. Daher sollten Verbraucher der Schnittstelle entweder die Verwendung gemeinsam genutzter Instanzen dieser Argumente für gleichzeitige Aufrufe vermeiden oder durch die Konstruktion sicherstellen, dass keine IChatClient Instanzen verwendet werden, die eine solche Mutation verwenden könnten. Die ConfigureOptions-Methode wird beispielsweise mit einem Rückruf bereitgestellt, der das angegebene Optionsargument stummschalten kann, und das sollte vermieden werden, wenn eine Singleton-Optionsinstanz verwendet wird.

Methoden

Name Beschreibung
Dispose()

Führt anwendungsdefinierte Aufgaben aus, die mit dem Freigeben, Freigeben oder Zurücksetzen nicht verwalteter Ressourcen verknüpft sind.

(Geerbt von IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Sendet Chatnachrichten und gibt die Antwort zurück.
GetService(Type, Object)

Fragt nach IChatClient einem Objekt des angegebenen Typs serviceType.
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Sendet Chatnachrichten und streamt die Antwort.

Erweiterungsmethoden

Name Beschreibung
AsBuilder(IChatClient)

Erstellt eine neue ChatClientBuilder Verwendung innerClient als inneren Client.
GetRequiredService(IChatClient, Type, Object)

Fragt nach IChatClient einem Objekt des angegebenen Typs serviceType und löst eine Ausnahme aus, wenn eine nicht verfügbar ist.
GetRequiredService<TService>(IChatClient, Object)

Fragt nach IChatClient einem Objekt vom Typ TService und löst eine Ausnahme aus, wenn ein Objekt nicht verfügbar ist.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Sendet eine Chatnachricht und gibt die Antwortnachrichten zurück.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Sendet eine Benutzerchattextnachricht und gibt die Antwortnachrichten zurück.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet eine Chatnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet eine Chatnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet Chatnachrichten und fordert eine Antwort an, die dem Typ Tentspricht.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet Chatnachrichten und fordert eine Antwort an, die dem Typ Tentspricht.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet eine Benutzerchattextnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Sendet eine Benutzerchattextnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
GetService<TService>(IChatClient, Object)

Fragt nach IChatClient einem Objekt vom Typ TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Sendet eine Chatnachricht und streamt die Antwortnachrichten.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Sendet eine Benutzerchattextnachricht und streamt die Antwortnachrichten.

Gilt für:

Weitere Informationen