IChatClient Antarmuka

Definisi

Ruang nama:
Microsoft.Extensions.AI
Rakitan:
Microsoft.Extensions.AI.Abstractions.dll
Paket:
Microsoft.Extensions.AI.Abstractions v10.6.0
Sumber:
IChatClient.cs

Mewakili klien obrolan.

public interface class IChatClient : IDisposable
public interface IChatClient : IDisposable
type IChatClient = interface
    interface IDisposable
Public Interface IChatClient
Implements IDisposable
Turunan
Penerapan
IDisposable

Keterangan

Aplikasi harus mempertimbangkan risiko seperti serangan injeksi perintah, ukuran data, dan jumlah pesan yang dikirim ke penyedia yang mendasar atau dikembalikan darinya. Kecuali implementasi tertentu IChatClient secara eksplisit mendokumentasikan perlindungan untuk masalah ini, aplikasi diharapkan untuk menerapkan perlindungan yang sesuai.

Kecuali ditentukan lain, semua anggota IChatClient aman utas untuk penggunaan bersamaan. Diharapkan bahwa semua implementasi IChatClient dukungan digunakan oleh beberapa permintaan secara bersamaan. Instans tidak boleh dibuang saat instans masih digunakan.

Namun, implementasi IChatClient mungkin mengubah argumen yang disediakan ke GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken) dan GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken), seperti dengan mengonfigurasi instans opsi. Dengan demikian, konsumen antarmuka harus menghindari penggunaan instans bersama dari argumen ini untuk pemanggilan bersamaan atau harus memastikan dengan konstruksi bahwa tidak ada IChatClient instans yang digunakan yang mungkin menggunakan mutasi tersebut. Misalnya, metode ConfigureOptions disediakan dengan panggilan balik yang dapat bermutasi argumen opsi yang disediakan, dan itu harus dihindari jika menggunakan instans opsi singleton.

Metode

Nama Deskripsi
Dispose()

Melakukan tugas yang ditentukan aplikasi yang terkait dengan membebaskan, merilis, atau mengatur ulang sumber daya yang tidak dikelola.

(Diperoleh dari IDisposable)
GetResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Mengirim pesan obrolan dan mengembalikan respons.
GetService(Type, Object)

IChatClient Meminta objek dari jenis serviceTypeyang ditentukan .
GetStreamingResponseAsync(IEnumerable<ChatMessage>, ChatOptions, CancellationToken)

Mengirim pesan obrolan dan mengalirkan respons.

Metode Ekstensi

Nama Deskripsi
AsBuilder(IChatClient)

Membuat penggunaan ChatClientBuilder baru innerClient sebagai klien dalamnya.
GetRequiredService(IChatClient, Type, Object)

IChatClient Meminta objek dari jenis serviceType yang ditentukan dan melemparkan pengecualian jika objek tidak tersedia.
GetRequiredService<TService>(IChatClient, Object)

IChatClient Meminta objek jenis TService dan melemparkan pengecualian jika objek tidak tersedia.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Mengirim pesan obrolan dan mengembalikan pesan respons.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Mengirim pesan teks obrolan pengguna dan mengembalikan pesan respons.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan teks obrolan pengguna, meminta respons yang cocok dengan jenis T.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Mengirim pesan teks obrolan pengguna, meminta respons yang cocok dengan jenis T.
GetService<TService>(IChatClient, Object)

IChatClient Meminta objek jenis TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)

Mengirim pesan obrolan dan mengalirkan pesan respons.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)

Mengirim pesan teks obrolan pengguna dan mengalirkan pesan respons.

Berlaku untuk

Lihat juga