ChatClientStructuredOutputExtensions.GetResponseAsync 方法

定義

命名空間:: Microsoft.Extensions.AI

組件:: Microsoft.Extensions.AI.dll

套件:: Microsoft.Extensions.AI v10.9.0

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

發送聊天訊息，請求符合的回應 T類型。

多載

名稱	Description
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)	發送聊天訊息，請求回應類型為 `T`。
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	發送聊天訊息，請求符合的回應 `T`類型。
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	發送用戶聊天簡訊，請求符合類型 `T`的回應。
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	發送聊天訊息，請求回應類型為 `T`。
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	發送聊天訊息，請求符合的回應 `T`類型。
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	發送用戶聊天簡訊，請求符合類型 `T`的回應。

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

來源:: ChatClientStructuredOutputExtensions.cs

發送聊天訊息，請求回應類型為 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))

類型參數

T

請求的結構化輸出類型。

參數

chatClient: IChatClient

IChatClient。

chatMessage: ChatMessage

要發送聊天訊息。

options: ChatOptions

聊天選項用來設定請求。

useJsonSchemaResponseFormat: Nullable<Boolean>

true在 ;（）設定 JSON 架構ChatResponseFormat;否則， false 預設值為 true。若底層模型支援原生結構化輸出與結構架構，使用 JSON 架構可提升可靠性;但若模型不支援，則可能出錯。

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<ChatResponse<T>>

客戶端產生的回應訊息。

適用於

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

來源:: ChatClientStructuredOutputExtensions.cs

發送聊天訊息，請求符合的回應 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))

類型參數

T

請求的結構化輸出類型。

參數

chatClient: IChatClient

IChatClient。

messages: IEnumerable<ChatMessage>

聊天內容要傳送。

options: ChatOptions

聊天選項用來設定請求。

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<ChatResponse<T>>

客戶端產生的回應訊息。

適用於

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

來源:: ChatClientStructuredOutputExtensions.cs

發送用戶聊天簡訊，請求符合類型 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))

類型參數

T

請求的結構化輸出類型。

參數

chatClient: IChatClient

IChatClient。

chatMessage: String

聊天訊息要發送的文字內容。

options: ChatOptions

聊天選項用來設定請求。

useJsonSchemaResponseFormat: Nullable<Boolean>

true在 ;（）設定 JSON 架構ChatResponseFormat;否則， false 若底層模型支援原生結構化輸出與結構架構，使用 JSON 架構可提升可靠性;但若模型不支援，則可能出錯。

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<ChatResponse<T>>

客戶端產生的回應訊息。

另請參閱

請求一個有結構化輸出的回應。

適用於

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

來源:: ChatClientStructuredOutputExtensions.cs

發送聊天訊息，請求回應類型為 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))

類型參數

T

請求的結構化輸出類型。

參數

chatClient: IChatClient

IChatClient。

chatMessage: ChatMessage

要發送聊天訊息。

serializerOptions: JsonSerializerOptions

可以使用 JSON 序列化選項。

options: ChatOptions

聊天選項用來設定請求。

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<ChatResponse<T>>

客戶端產生的回應訊息。

適用於

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

來源:: ChatClientStructuredOutputExtensions.cs

發送聊天訊息，請求符合的回應 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))

類型參數

T

請求的結構化輸出類型。

參數

chatClient: IChatClient

IChatClient。

messages: IEnumerable<ChatMessage>

聊天內容要傳送。

serializerOptions: JsonSerializerOptions

可以使用 JSON 序列化選項。

options: ChatOptions

聊天選項用來設定請求。

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<ChatResponse<T>>

客戶端產生的回應訊息。

例外狀況

ArgumentNullException

chatClient或messagesserializerOptions是 null。

適用於

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

來源:: ChatClientStructuredOutputExtensions.cs

發送用戶聊天簡訊，請求符合類型 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))