ChatClientStructuredOutputExtensions.GetResponseAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia uma mensagem de chat solicitando uma resposta que corresponda ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- chatMessage
- ChatMessage
A mensagem de chat a ser enviada.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false. O padrão é true.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
Aplica-se a
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia mensagens de chat, solicitando uma resposta que corresponda ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- messages
- IEnumerable<ChatMessage>
O conteúdo do chat a ser enviado.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false. O padrão é true.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
Aplica-se a
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia uma mensagem de texto de chat do usuário solicitando uma resposta correspondente ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- chatMessage
- String
O conteúdo do texto da mensagem de chat a ser enviada.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
Confira também
Aplica-se a
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia uma mensagem de chat solicitando uma resposta que corresponda ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- chatMessage
- ChatMessage
A mensagem de chat a ser enviada.
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a serem usadas.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false. O padrão é true.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
Aplica-se a
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia mensagens de chat, solicitando uma resposta que corresponda ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- messages
- IEnumerable<ChatMessage>
O conteúdo do chat a ser enviado.
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a serem usadas.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false. O padrão é true.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
Exceções
chatClient ou ou messagesserializerOptions é null.
Aplica-se a
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envia uma mensagem de texto de chat do usuário solicitando uma resposta correspondente ao tipo 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))Parâmetros de tipo
- T
O tipo de saída estruturada a ser solicitada.
Parâmetros
- chatClient
- IChatClient
O IChatClient.
- chatMessage
- String
O conteúdo do texto da mensagem de chat a ser enviada.
- serializerOptions
- JsonSerializerOptions
As opções de serialização JSON a serem usadas.
- options
- ChatOptions
As opções de chat para configurar a solicitação.
true para definir um esquema JSON no ChatResponseFormat; caso contrário, false. O padrão é true.
O uso de um esquema JSON melhorará a confiabilidade se o modelo subjacente oferecer suporte à saída estruturada nativa com um esquema, mas poderá causar um erro se o modelo não der suporte a ele.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
As mensagens de resposta geradas pelo cliente.
