VoiceAgentRealtimeResponse interface

Pacote:

@azure/ai-projects

Uma resposta em tempo real em tempo real devolvida pelo serviço de voice-agent em ambos response.createdresponse.done os eventos.

Extends

VoiceAgentRealtimeResponseBase

Propriedades

audio	A configuração áudio usada pela resposta ao vivo, incluindo o fornecedor de voz plana, localização e campos de formato sob output.
output	Os itens produzidos pela resposta em direto.

Propriedades Herdadas

conversation_id	A que conversa a resposta é adicionada, determinada pelo conversation campo no 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 ativadas 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 nesta resposta.
metadata	Pares chave-valor personalizados 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 inclui sempre uma transcrição de texto. Definir a saída para modo text desativa a saída de áudio do modelo.
status	O estado final da resposta (completed, cancelled, failed, ou incomplete, in_progress).
status_details	Detalhes adicionais sobre o estado.
usage	Estatísticas de utilização para a Resposta, isto corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, pelo que a saída de turnos anteriores (tokens de texto e áudio) passará a ser a entrada para turnos posteriores.

Detalhes de Propriedade

audio

A configuração áudio usada pela resposta ao vivo, incluindo o fornecedor de voz plana, localização e campos de formato sob output.

audio?: VoiceResponseAudio

Valor de Propriedade

VoiceResponseAudio

output

Os itens produzidos pela resposta em direto.

output?: RealtimeConversationItemUnion[]

Valor de Propriedade

RealtimeConversationItemUnion[]

Detalhes da Propriedade Herdada

conversation_id

A que conversa a resposta é adicionada, determinada pelo conversation campo no 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 ativadas automaticamente pelo VAD, a resposta será adicionada à conversa padrão

conversation_id?: string

Valor de Propriedade

string

Herdado deVoiceAgentRealtimeResponseBase.conversation_id

id

O ID único da resposta será .resp_1234

id?: string

Valor de Propriedade

string

Herdado deVoiceAgentRealtimeResponseBase.id

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 nesta resposta.

max_output_tokens?: number | "inf"

Valor de Propriedade

number | "inf"

Herdado deVoiceAgentRealtimeResponseBase.max_output_tokens

metadata

Pares chave-valor personalizados associados à resposta.

metadata?: Metadata

Valor de Propriedade

Metadata

Herdado deVoiceAgentRealtimeResponseBase.metadata

object

O tipo de objeto, deve ser realtime.response.

object?: "realtime.response"

Valor de Propriedade

"realtime.response"

Herdado deVoiceAgentRealtimeResponseBase.object

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 inclui sempre uma transcrição de texto. Definir a saída para modo text desativa a saída de áudio do modelo.

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

Valor de Propriedade

("text" | "audio")[]

Herdado deVoiceAgentRealtimeResponseBase.output_modalities

status

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

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

Valor de Propriedade

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

Herdado deVoiceAgentRealtimeResponseBase.status

status_details

Detalhes adicionais sobre o estado.

status_details?: RealtimeResponseStatusDetails

Valor de Propriedade

RealtimeResponseStatusDetails

Herdado deVoiceAgentRealtimeResponseBase.status_details

usage

Estatísticas de utilização para a Resposta, isto corresponderá à faturação. Uma sessão de API em tempo real manterá um contexto de conversa e adicionará novos Itens à conversa, pelo que a saída de turnos anteriores (tokens de texto e áudio) passará a ser a entrada para turnos posteriores.

usage?: RealtimeResponseUsage

Valor de Propriedade

RealtimeResponseUsage

Herdado deVoiceAgentRealtimeResponseBase.usage