VoiceAgentRealtimeResponseBase interface

Pacote:

@azure/ai-projects

Propriedades compartilhadas por respostas em tempo real retornadas pelo serviço de agente de voz.

Propriedades

conversation_id	A conversa à qual a resposta é adicionada, determinada pelo conversation campo do response.create evento. Se auto, a resposta será adicionada à conversa padrão e o valor de conversation_id será um id como conv_1234. Se none, a resposta não será adicionada a nenhuma conversa e o valor de conversation_id será null. Se as respostas forem acionadas automaticamente pelo VAD, a resposta será adicionada à conversa padrão
id	O ID único da resposta será .resp_1234
max_output_tokens	Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta, que foi usado nessa resposta.
metadata	Pares chave-valor personalizados de string associados à resposta.
object	O tipo de objeto deve ser realtime.response.
output_modalities	O conjunto de modalidades que o modelo usou para responder, atualmente os únicos valores possíveis são [\"audio\"], [\"text\"]. A saída de áudio sempre inclui uma transcrição de texto. Configurar a saída para modo text desativa a saída de áudio do modelo.
status	O status final da resposta (completed, cancelled, failed, ou incomplete, in_progress).
status_details	Detalhes adicionais sobre o status.
usage	Estatísticas de uso para a Resposta, isso corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, assim, a saída de turnos anteriores (tokens de texto e áudio) se tornará a entrada para turnos posteriores.

Detalhes da propriedade

conversation_id

A conversa à qual a resposta é adicionada, determinada pelo conversation campo do response.create evento. Se auto, a resposta será adicionada à conversa padrão e o valor de conversation_id será um id como conv_1234. Se none, a resposta não será adicionada a nenhuma conversa e o valor de conversation_id será null. Se as respostas forem acionadas automaticamente pelo VAD, a resposta será adicionada à conversa padrão

conversation_id?: string

Valor da propriedade

string

id

O ID único da resposta será .resp_1234

id?: string

Valor da propriedade

string

max_output_tokens

Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta, que foi usado nessa resposta.

max_output_tokens?: number | "inf"

Valor da propriedade

number | "inf"

metadata

Pares chave-valor personalizados de string associados à resposta.

metadata?: Metadata

Valor da propriedade

Metadata

object

O tipo de objeto deve ser realtime.response.

object?: "realtime.response"

Valor da propriedade

"realtime.response"

output_modalities

O conjunto de modalidades que o modelo usou para responder, atualmente os únicos valores possíveis são [\"audio\"], [\"text\"]. A saída de áudio sempre inclui uma transcrição de texto. Configurar a saída para modo text desativa a saída de áudio do modelo.

output_modalities?: ("text" | "audio")[]

Valor da propriedade

("text" | "audio")[]

status

O status final da resposta (completed, cancelled, failed, ou incomplete, in_progress).

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Valor da propriedade

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

status_details

Detalhes adicionais sobre o status.

status_details?: RealtimeResponseStatusDetails

Valor da propriedade

RealtimeResponseStatusDetails

usage

Estatísticas de uso para a Resposta, isso corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, assim, a saída de turnos anteriores (tokens de texto e áudio) se tornará a entrada para turnos posteriores.

usage?: RealtimeResponseUsage

Valor da propriedade

RealtimeResponseUsage