ChatClientStructuredOutputExtensions.GetResponseAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Envoie des messages de conversation, en demandant une réponse correspondant au type T.
Surcharges
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie un message de conversation, en demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- chatMessage
- ChatMessage
Message de conversation à envoyer.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false. La valeur par défaut est true.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.
S’applique à
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie des messages de conversation, en demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- messages
- IEnumerable<ChatMessage>
Contenu de conversation à envoyer.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false. La valeur par défaut est true.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.
S’applique à
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie un sms de conversation utilisateur, demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- chatMessage
- String
Contenu texte du message de conversation à envoyer.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.
Voir aussi
S’applique à
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie un message de conversation, en demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- chatMessage
- ChatMessage
Message de conversation à envoyer.
- serializerOptions
- JsonSerializerOptions
Options de sérialisation JSON à utiliser.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false. La valeur par défaut est true.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.
S’applique à
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie des messages de conversation, en demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- messages
- IEnumerable<ChatMessage>
Contenu de conversation à envoyer.
- serializerOptions
- JsonSerializerOptions
Options de sérialisation JSON à utiliser.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false. La valeur par défaut est true.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.
Exceptions
chatClient
messages ou serializerOptions est null.
S’applique à
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Envoie un sms de conversation utilisateur, demandant une réponse correspondant au type 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))
Paramètres de type
- T
Type de sortie structurée à demander.
Paramètres
- chatClient
- IChatClient
L’attribut IChatClient.
- chatMessage
- String
Contenu texte du message de conversation à envoyer.
- serializerOptions
- JsonSerializerOptions
Options de sérialisation JSON à utiliser.
- options
- ChatOptions
Options de conversation pour configurer la requête.
true pour définir un schéma JSON sur le ChatResponseFormat; sinon, false. La valeur par défaut est true.
L’utilisation d’un schéma JSON améliore la fiabilité si le modèle sous-jacent prend en charge la sortie structurée native avec un schéma, mais peut entraîner une erreur si le modèle ne le prend pas en charge.
- cancellationToken
- CancellationToken
À CancellationToken surveiller pour les demandes d’annulation. La valeur par défaut est None.
Retours
Messages de réponse générés par le client.