IChatClient Gränssnitt

Definition

Representerar en chattklient.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Härledda
Implementeringar

Kommentarer

Program måste ta hänsyn till risker som snabbinmatningsattacker, datastorlekar och antalet meddelanden som skickas till den underliggande providern eller som returneras från den. Om inte en specifik IChatClient implementering uttryckligen dokumenterar skydd för dessa problem förväntas programmet implementera lämpliga skydd.

Om inget annat anges är alla medlemmar i IChatClient trådsäkra för samtidig användning. Det förväntas att alla implementeringar av IChatClient stöd används av flera begäranden samtidigt. Instanser får inte tas bort medan instansen fortfarande används.

Implementeringar av IChatClient kan dock mutera argumenten som anges till och GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken), till GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) exempel genom att konfigurera alternativinstansen. Därför bör användare av gränssnittet antingen undvika att använda delade instanser av dessa argument för samtidiga anrop eller på annat sätt säkerställa genom konstruktion att inga IChatClient instanser används som kan använda en sådan mutation. Metoden ConfigureOptions tillhandahålls till exempel med ett återanrop som kan mutera argumentet med de angivna alternativen, och det bör undvikas om du använder en singleton-alternativinstans.

Metoder

Name Description
Dispose()

Utför programdefinierade uppgifter som är associerade med att frigöra, frigöra eller återställa ohanterade resurser.

(Ärvd från IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Skickar chattmeddelanden och returnerar svaret.

GetService(Type, Object)

Frågar efter IChatClient ett objekt av den angivna typen serviceType.

GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Skickar chattmeddelanden och strömmar svaret.

Tilläggsmetoder

Name Description
AsBuilder(IChatClient)

Skapar en ny ChatClientBuilder som använder innerClient som sin inre klient.

GetRequiredService(IChatClient, Type, Object)

Frågar efter IChatClient ett objekt av den angivna typen serviceType och utlöser ett undantag om ett inte är tillgängligt.

GetRequiredService<TService>(IChatClient, Object)

Frågar efter IChatClient ett objekt av typen TService och utlöser ett undantag om ett inte är tillgängligt.

GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Skickar ett chattmeddelande och returnerar svarsmeddelandena.

GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Skickar ett sms för användarchatt och returnerar svarsmeddelandena.

GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar ett chattmeddelande och begär ett svar som matchar typen T.

GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar ett chattmeddelande och begär ett svar som matchar typen T.

GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar chattmeddelanden och begär ett svar som matchar typen T.

GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar chattmeddelanden och begär ett svar som matchar typen T.

GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar ett sms för användarchatt och begär ett svar som matchar typen T.

GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Skickar ett sms för användarchatt och begär ett svar som matchar typen T.

GetService<TService>(IChatClient, Object)

Frågar efter IChatClient ett objekt av typen TService.

GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Skickar ett chattmeddelande och strömmar svarsmeddelandena.

GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Skickar ett sms för användarchatt och strömmar svarsmeddelandena.

Gäller för

Se även