ChatClientStructuredOutputExtensions.GetResponseAsync Metode

Definisi

Ruang nama:

Microsoft.Extensions.AI

Rakitan:

Microsoft.Extensions.AI.dll

Paket:

Microsoft.Extensions.AI v10.9.0

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.

Overload

Nama	Deskripsi
GetResponseAsync<T>(IChatClient, ChatMessage, 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, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Mengirim pesan teks obrolan pengguna, 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>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Mengirim pesan obrolan, 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.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, Microsoft.Extensions.AI.ChatMessage chatMessage, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * Microsoft.Extensions.AI.ChatMessage * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As ChatMessage, Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

chatMessage

ChatMessage

Pesan obrolan yang akan dikirim.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Defaultnya adalah true. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, messages As IEnumerable(Of ChatMessage), Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

messages

IEnumerable<ChatMessage>

Konten obrolan yang akan dikirim.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Defaultnya adalah true. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan teks obrolan pengguna, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * string * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As String, Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

chatMessage

String

Konten teks untuk dikirim pesan obrolan.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.

Lihat juga

• Minta respons dengan output terstruktur.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, Microsoft.Extensions.AI.ChatMessage chatMessage, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * Microsoft.Extensions.AI.ChatMessage * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As ChatMessage, serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

chatMessage

ChatMessage

Pesan obrolan yang akan dikirim.

serializerOptions

JsonSerializerOptions

Opsi serialisasi JSON untuk digunakan.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Defaultnya adalah true. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan obrolan, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * seq<Microsoft.Extensions.AI.ChatMessage> * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, messages As IEnumerable(Of ChatMessage), serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

messages

IEnumerable<ChatMessage>

Konten obrolan yang akan dikirim.

serializerOptions

JsonSerializerOptions

Opsi serialisasi JSON untuk digunakan.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Defaultnya adalah true. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.

Pengecualian

ArgumentNullException

chatClient atau messages atau serializerOptions adalah null.

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

Sumber:

ChatClientStructuredOutputExtensions.cs

Mengirim pesan teks obrolan pengguna, meminta respons yang cocok dengan jenis T.

public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T>(this Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchemaResponseFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * string * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>

<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As String, serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchemaResponseFormat As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))

Jenis parameter

T

Jenis output terstruktur untuk diminta.

Parameter

chatClient

IChatClient

IChatClient.

chatMessage

String

Konten teks untuk dikirim pesan obrolan.

serializerOptions

JsonSerializerOptions

Opsi serialisasi JSON untuk digunakan.

options

ChatOptions

Opsi obrolan untuk mengonfigurasi permintaan.

useJsonSchemaResponseFormat

Nullable<Boolean>

true untuk mengatur skema JSON pada ChatResponseFormat; jika tidak, false. Defaultnya adalah true. Menggunakan skema JSON meningkatkan keandalan jika model yang mendasar mendukung output terstruktur asli dengan skema, tetapi dapat menyebabkan kesalahan jika model tidak mendukungnya.

cancellationToken

CancellationToken

CancellationToken untuk memantau permintaan pembatalan. Defaultnya adalah None.

Mengembalikan

Task<ChatResponse<T>>

Pesan respons yang dihasilkan oleh klien.