ChatClientStructuredOutputExtensions.GetResponseAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía un mensaje de chat y solicita una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- chatMessage
- ChatMessage
Mensaje de chat que se va a enviar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false. El valor predeterminado es true.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
Se aplica a
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía mensajes de chat, solicitando una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- messages
- IEnumerable<ChatMessage>
Contenido del chat que se va a enviar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false. El valor predeterminado es true.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
Se aplica a
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía un mensaje de texto de chat de usuario, solicitando una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- chatMessage
- String
Contenido de texto del mensaje de chat que se va a enviar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
Consulte también
Se aplica a
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía un mensaje de chat y solicita una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- chatMessage
- ChatMessage
Mensaje de chat que se va a enviar.
- serializerOptions
- JsonSerializerOptions
Las opciones de serialización JSON que se van a usar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false. El valor predeterminado es true.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
Se aplica a
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía mensajes de chat, solicitando una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- messages
- IEnumerable<ChatMessage>
Contenido del chat que se va a enviar.
- serializerOptions
- JsonSerializerOptions
Las opciones de serialización JSON que se van a usar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false. El valor predeterminado es true.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
Excepciones
chatClient o messages es serializerOptionsnull.
Se aplica a
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envía un mensaje de texto de chat de usuario, solicitando una respuesta que coincida con el 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
Tipo de salida estructurada que se va a solicitar.
Parámetros
- chatClient
- IChatClient
El IChatClient.
- chatMessage
- String
Contenido de texto del mensaje de chat que se va a enviar.
- serializerOptions
- JsonSerializerOptions
Las opciones de serialización JSON que se van a usar.
- options
- ChatOptions
Opciones de chat para configurar la solicitud.
true para establecer un esquema JSON en ChatResponseFormat; de lo contrario, false. El valor predeterminado es true.
El uso de un esquema JSON mejora la confiabilidad si el modelo subyacente admite la salida estructurada nativa con un esquema, pero podría provocar un error si el modelo no lo admite.
- cancellationToken
- CancellationToken
que CancellationToken se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.
Devoluciones
Los mensajes de respuesta generados por el cliente.
