ChatClientStructuredOutputExtensions.GetResponseAsync Метод

Определение

Пространство имен:: Microsoft.Extensions.AI

Сборка:: Microsoft.Extensions.AI.dll

Пакет:: Microsoft.Extensions.AI v10.7.0

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Отправляет сообщения чата, запрашивая ответ, соответствующий типу T.

Перегрузки

Имя	Описание
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет сообщение чата, запрашивая ответ, соответствующий типу `T`.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет сообщения чата, запрашивая ответ, соответствующий типу `T`.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет текстовое сообщение чата пользователя, запрашивая ответ, соответствующий типу `T`.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет сообщение чата, запрашивая ответ, соответствующий типу `T`.
GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет сообщения чата, запрашивая ответ, соответствующий типу `T`.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Отправляет текстовое сообщение чата пользователя, запрашивая ответ, соответствующий типу `T`.

GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет сообщение чата, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

chatMessage: ChatMessage

Сообщение чата для отправки.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

trueЗначение , ChatResponseFormatчтобы задать схему JSON в ; falseв противном случае . Значение по умолчанию — true. Использование схемы JSON повышает надежность, если базовая модель поддерживает собственные структурированные выходные данные со схемой, но может привести к ошибке, если модель не поддерживает ее.

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

Применяется к

GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет сообщения чата, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

messages: IEnumerable<ChatMessage>

Содержимое чата для отправки.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

Применяется к

GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет текстовое сообщение чата пользователя, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

chatMessage: String

Текстовое содержимое для отправки сообщения чата.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

trueЗначение , ChatResponseFormatчтобы задать схему JSON в ; falseв противном случае . Использование схемы JSON повышает надежность, если базовая модель поддерживает собственные структурированные выходные данные со схемой, но может привести к ошибке, если модель не поддерживает ее.

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

См. также раздел

Запрос ответа со структурированными выходными данными.

Применяется к

GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет сообщение чата, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

chatMessage: ChatMessage

Сообщение чата для отправки.

serializerOptions: JsonSerializerOptions

Используемые параметры сериализации JSON.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

Применяется к

GetResponseAsync<T>(IChatClient, IEnumerable<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет сообщения чата, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

messages: IEnumerable<ChatMessage>

Содержимое чата для отправки.

serializerOptions: JsonSerializerOptions

Используемые параметры сериализации JSON.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

Исключения

ArgumentNullException

chatClient или messagesserializerOptions есть null.

Применяется к

GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)

Исходный код:: ChatClientStructuredOutputExtensions.cs

Отправляет текстовое сообщение чата пользователя, запрашивая ответ, соответствующий типу 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))

Параметры типа

T

Тип структурированных выходных данных для запроса.

Параметры

chatClient: IChatClient

Объект IChatClient.

chatMessage: String

Текстовое содержимое для отправки сообщения чата.

serializerOptions: JsonSerializerOptions

Используемые параметры сериализации JSON.

options: ChatOptions

Параметры чата для настройки запроса.

useJsonSchemaResponseFormat: Nullable<Boolean>

cancellationToken: CancellationToken

Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

Task<ChatResponse<T>>

Ответные сообщения, созданные клиентом.

Применяется к

Обратная связь

Были ли сведения на этой странице полезными?