ChatClientStructuredOutputExtensions.GetResponseAsync Methode
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Verzendt chatberichten, waarbij een antwoord wordt aangevraagd dat overeenkomt met het type T.
Overloads
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt een chatbericht, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- chatMessage
- ChatMessage
Het chatbericht dat moet worden verzonden.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false De standaardwaarde is true.
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.
Van toepassing op
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt chatberichten, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- messages
- IEnumerable<ChatMessage>
De chatinhoud die moet worden verzonden.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false De standaardwaarde is true.
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.
Van toepassing op
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt een chatbericht van een gebruiker, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- chatMessage
- String
De tekstinhoud voor het chatbericht dat moet worden verzonden.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.
Zie ook
Van toepassing op
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt een chatbericht, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- chatMessage
- ChatMessage
Het chatbericht dat moet worden verzonden.
- serializerOptions
- JsonSerializerOptions
De te gebruiken JSON-serialisatieopties.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false De standaardwaarde is true.
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.
Van toepassing op
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt chatberichten, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- messages
- IEnumerable<ChatMessage>
De chatinhoud die moet worden verzonden.
- serializerOptions
- JsonSerializerOptions
De te gebruiken JSON-serialisatieopties.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false De standaardwaarde is true.
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.
Uitzonderingen
chatClient
messages of serializerOptions is null.
Van toepassing op
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Verzendt een chatbericht van een gebruiker, waarbij een antwoord wordt aangevraagd dat overeenkomt met het 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))
Type parameters
- T
Het type gestructureerde uitvoer dat moet worden aangevraagd.
Parameters
- chatClient
- IChatClient
De IChatClient.
- chatMessage
- String
De tekstinhoud voor het chatbericht dat moet worden verzonden.
- serializerOptions
- JsonSerializerOptions
De te gebruiken JSON-serialisatieopties.
- options
- ChatOptions
De chatopties voor het configureren van de aanvraag.
trueom een JSON-schema in te stellen op de ChatResponseFormat; anders. false De standaardwaarde is true.
Het gebruik van een JSON-schema verbetert de betrouwbaarheid als het onderliggende model systeemeigen gestructureerde uitvoer ondersteunt met een schema, maar kan een fout veroorzaken als het model dit niet ondersteunt.
- cancellationToken
- CancellationToken
De CancellationToken te controleren op annuleringsaanvragen. De standaardwaarde is None.
Retouren
De antwoordberichten die door de client worden gegenereerd.