ChatClientStructuredOutputExtensions.GetResponseAsync Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Odesílá chatové zprávy a žádá o odpověď odpovídající typu T.
Přetížení
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Odešle chatovou zprávu a požádá o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- chatMessage
- ChatMessage
Zpráva chatu, kterou chcete odeslat.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false. Výchozí hodnota je true.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.
Platí pro
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Odesílá chatové zprávy a žádá o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- messages
- IEnumerable<ChatMessage>
Obsah chatu, který se má odeslat.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false. Výchozí hodnota je true.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.
Platí pro
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Odešle textovou zprávu chatu uživatele s žádostí o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- chatMessage
- String
Textový obsah zprávy chatu, který se má odeslat.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.
Viz také
Platí pro
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Odešle chatovou zprávu a požádá o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- chatMessage
- ChatMessage
Zpráva chatu, kterou chcete odeslat.
- serializerOptions
- JsonSerializerOptions
Možnosti serializace JSON, které se mají použít.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false. Výchozí hodnota je true.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.
Platí pro
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Odesílá chatové zprávy a žádá o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- messages
- IEnumerable<ChatMessage>
Obsah chatu, který se má odeslat.
- serializerOptions
- JsonSerializerOptions
Možnosti serializace JSON, které se mají použít.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false. Výchozí hodnota je true.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.
Výjimky
chatClient nebo messagesserializerOptions je null.
Platí pro
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Odešle textovou zprávu chatu uživatele s žádostí o odpověď odpovídající typu 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))
Parametry typu
- T
Typ strukturovanéhovýstupho
Parametry
- chatClient
- IChatClient
- chatMessage
- String
Textový obsah zprávy chatu, který se má odeslat.
- serializerOptions
- JsonSerializerOptions
Možnosti serializace JSON, které se mají použít.
- options
- ChatOptions
Možnosti chatu pro konfiguraci žádosti.
true pro nastavení schématu JSON na objektu ChatResponseFormat; v opačném případě false. Výchozí hodnota je true.
Použití schématu JSON zlepšuje spolehlivost, pokud základní model podporuje nativní strukturovaný výstup se schématem, ale může způsobit chybu, pokud ho model nepodporuje.
- cancellationToken
- CancellationToken
Monitorování CancellationToken žádostí o zrušení Výchozí hodnota je None.
Návraty
Zprávy odpovědí vygenerované klientem.