IChatClient 介面

定義

命名空間:
Microsoft.Extensions.AI
組件:
Microsoft.Extensions.AI.Abstractions.dll
套件:
Microsoft.Extensions.AI.Abstractions v10.6.0
來源:
IChatClient.cs

代表一個聊天客戶端。

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
衍生
實作
IDisposable

備註

應用程式必須考慮風險，例如提示注入攻擊、資料大小，以及發送給底層提供者或回傳的訊息數量。 除非特定 IChatClient 實作明確記錄這些問題的保障措施，否則應用程式預期會實施適當的保護措施。

除非另有說明，所有成員 IChatClient 皆為執行緒安全，可同時使用。 預期所有支援實作 IChatClient 同時被多個請求使用。 實例在仍在使用期間，不得被處置。

然而，的IChatClient實作可能會改變所提供的參數，GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)例如配置選項實例。 因此，介面使用者應避免使用這些參數的共享實例進行並行調用，或應透過設計確保不會 IChatClient 使用可能使用此類變異的實例。 例如，ConfigureOptions 方法附帶一個回調，可能會改變所提供的選項參數，若使用單例期權實例，應避免此操作。

方法

名稱 Description
Dispose()

執行與釋放、釋放或重設非受控資源相關聯的應用程式定義工作。

(繼承來源 IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

發送聊天訊息並回覆。
GetService(Type, Object)

請求 給 IChatClient 指定類型的 serviceType物件。
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

發送聊天訊息並直播回覆。

擴充方法

名稱 Description
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)

發送用戶聊天簡訊並串流回應訊息。

適用於

另請參閱