ChatClientStructuredOutputExtensions.GetResponseAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Sendet Chatnachrichten und fordert eine Antwort an, die dem Typ Tentspricht.
Überlädt
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet eine Chatnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- chatMessage
- ChatMessage
Die zu sendende Chatnachricht.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false. Der Standardwert lautet true.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
Gilt für:
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet Chatnachrichten und fordert eine Antwort an, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- messages
- IEnumerable<ChatMessage>
Der zu sendende Chatinhalt.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false. Der Standardwert lautet true.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
Gilt für:
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet eine Benutzerchattextnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- chatMessage
- String
Der Textinhalt der zu sendenden Chatnachricht.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
Weitere Informationen
Gilt für:
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet eine Chatnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- chatMessage
- ChatMessage
Die zu sendende Chatnachricht.
- serializerOptions
- JsonSerializerOptions
Die zu verwendenden JSON-Serialisierungsoptionen.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false. Der Standardwert lautet true.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
Gilt für:
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet Chatnachrichten und fordert eine Antwort an, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- messages
- IEnumerable<ChatMessage>
Der zu sendende Chatinhalt.
- serializerOptions
- JsonSerializerOptions
Die zu verwendenden JSON-Serialisierungsoptionen.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false. Der Standardwert lautet true.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
Ausnahmen
chatClientoder messagesserializerOptions ist .null
Gilt für:
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)
Sendet eine Benutzerchattextnachricht, die eine Antwort anfordert, die dem Typ Tentspricht.
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))Typparameter
- T
Der Typ der strukturierten Ausgabe, die angefordert werden soll.
Parameter
- chatClient
- IChatClient
Die IChatClient.
- chatMessage
- String
Der Textinhalt der zu sendenden Chatnachricht.
- serializerOptions
- JsonSerializerOptions
Die zu verwendenden JSON-Serialisierungsoptionen.
- options
- ChatOptions
Die Chatoptionen zum Konfigurieren der Anforderung.
true zum Festlegen eines JSON-Schemas für das ChatResponseFormat; andernfalls false. Der Standardwert lautet true.
Die Verwendung eines JSON-Schemas verbessert die Zuverlässigkeit, wenn das zugrunde liegende Modell systemeigene strukturierte Ausgabe mit einem Schema unterstützt, kann jedoch einen Fehler verursachen, wenn das Modell sie nicht unterstützt.
- cancellationToken
- CancellationToken
Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.
Gibt zurück
Die vom Client generierten Antwortnachrichten.
