IChatClient インターフェイス

定義

チャット クライアントを表します。

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
派生
実装

注釈

アプリケーションでは、プロンプトインジェクション攻撃、データ サイズ、基になるプロバイダーに送信されたメッセージまたはそこから返されるメッセージの数などのリスクを考慮する必要があります。 特定の IChatClient 実装がこれらの懸念に対するセーフガードを明示的に文書化しない限り、アプリケーションは適切な保護を実装することが期待されます。

特に指定しない限り、 IChatClient のすべてのメンバーは同時使用のためにスレッド セーフです。 IChatClientサポートのすべての実装が複数の要求で同時に使用されることが予想されます。 インスタンスがまだ使用されている間は、インスタンスを破棄しないでください。

ただし、 IChatClient の実装では、オプション インスタンスの構成など、 GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)に指定された引数が変更される場合があります。 したがって、インターフェイスのコンシューマーは、これらの引数の共有インスタンスを同時呼び出しに使用しないようにするか、またはそのような変更を使用する可能性のある IChatClient インスタンスが使用されないように構築する必要があります。 たとえば、ConfigureOptions メソッドには、指定されたオプション引数を変更できるコールバックが用意されており、シングルトン オプション インスタンスを使用する場合は避ける必要があります。

メソッド

名前 説明
Dispose()

アンマネージド リソースの解放、解放、またはリセットに関連付けられているアプリケーション定義のタスクを実行します。

(継承元 IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

チャット メッセージを送信し、応答を返します。

GetService(Type, Object)

指定した型IChatClientのオブジェクトをserviceTypeに要求します。

GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

チャット メッセージを送信し、応答をストリームします。

拡張メソッド

名前 説明
AsBuilder(IChatClient)

ChatClientBuilderを内部クライアントとして使用して、新しいinnerClientを作成します。

GetRequiredService(IChatClient, Type, Object)

指定した型IChatClientのオブジェクトをserviceTypeに要求し、使用できない場合は例外をスローします。

GetRequiredService<TService>(IChatClient, Object)

IChatClient型のオブジェクトをTServiceに要求し、使用できない場合は例外をスローします。

GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

チャット メッセージを送信し、応答メッセージを返します。

GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

ユーザー チャット テキスト メッセージを送信し、応答メッセージを返します。

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

チャット メッセージを送信し、 Tの種類に一致する応答を要求します。

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

チャット メッセージを送信し、 Tの種類に一致する応答を要求します。

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

チャット メッセージを送信し、 Tの種類に一致する応答を要求します。

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

チャット メッセージを送信し、 Tの種類に一致する応答を要求します。

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

ユーザー チャット テキスト メッセージを送信し、 Tの種類に一致する応答を要求します。

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

ユーザー チャット テキスト メッセージを送信し、 Tの種類に一致する応答を要求します。

GetService<TService>(IChatClient, Object)

IChatClient型のオブジェクトをTServiceに求めます。

GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

チャット メッセージを送信し、応答メッセージをストリーミングします。

GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

ユーザー チャット テキスト メッセージを送信し、応答メッセージをストリーミングします。

適用対象

こちらもご覧ください