IChatClient Interface

Definitie

Vertegenwoordigt een chatclient.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Afgeleid
Implementeringen

Opmerkingen

Toepassingen moeten rekening houden met risico's zoals aanvallen met promptinjectie, gegevensgrootten en het aantal berichten dat naar de onderliggende provider wordt verzonden of geretourneerd. Tenzij een specifieke IChatClient implementatie expliciet veiligheidsmaatregelen voor deze problemen documenteert, wordt verwacht dat de toepassing passende beveiligingen implementeert.

Tenzij anders opgegeven, zijn alle leden IChatClient thread-safe voor gelijktijdig gebruik. Er wordt verwacht dat alle implementaties van IChatClient ondersteuning die gelijktijdig door meerdere aanvragen worden gebruikt. Exemplaren mogen niet worden verwijderd terwijl het exemplaar nog in gebruik is.

Implementaties van IChatClient kunnen echter de argumenten die worden opgegeven, GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) dempen en GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken), zoals door het exemplaar van de opties te configureren. Consumenten van de interface moeten dus geen gebruik maken van gedeelde exemplaren van deze argumenten voor gelijktijdige aanroepen of anderszins garanderen dat er geen IChatClient exemplaren worden gebruikt die een dergelijke mutatie kunnen gebruiken. De methode ConfigureOptions wordt bijvoorbeeld geleverd met een callback waarmee het opgegeven optiesargument kan worden gedempt en dat moet worden vermeden als u een instantie van singleton-opties gebruikt.

Methoden

Name Description
Dispose()

Voert door de toepassing gedefinieerde taken uit die zijn gekoppeld aan het vrijmaken, vrijgeven of opnieuw instellen van onbeheerde resources.

(Overgenomen van IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Verzendt chatberichten en retourneert het antwoord.

GetService(Type, Object)

Vraagt om een IChatClient object van het opgegeven type serviceType.

GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Hiermee worden chatberichten verzonden en het antwoord gestreamd.

Extensiemethoden

Name Description
AsBuilder(IChatClient)

Hiermee maakt u een nieuw ChatClientBuilder gebruik innerClient als de interne client.

GetRequiredService(IChatClient, Type, Object)

Vraagt om IChatClient een object van het opgegeven type serviceType en genereert een uitzondering als deze niet beschikbaar is.

GetRequiredService<TService>(IChatClient, Object)

Vraagt om IChatClient een object van het type TService en genereert een uitzondering als deze niet beschikbaar is.

GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Hiermee wordt een chatbericht verzonden en worden de antwoordberichten geretourneerd.

GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Hiermee wordt een sms-bericht van een gebruiker verzonden en worden de antwoordberichten geretourneerd.

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

Verzendt een chatbericht, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

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

Verzendt een chatbericht, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

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

Verzendt chatberichten, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

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

Verzendt chatberichten, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

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

Verzendt een chatbericht van een gebruiker, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

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

Verzendt een chatbericht van een gebruiker, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.

GetService<TService>(IChatClient, Object)

Vraagt om een IChatClient object van het type TService.

GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Verzendt een chatbericht en streamt de antwoordberichten.

GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Hiermee wordt een sms-bericht van een gebruiker verzonden en worden de antwoordberichten gestreamd.

Van toepassing op

Zie ook