VoiceAgentRealtimeResponse interface
Uma resposta ao vivo em tempo real retornada pelo serviço de agente de voz em ambos response.createdresponse.done os eventos.
- Extends
Propriedades
| audio | A configuração de áudio usada pela resposta ao vivo, incluindo provedor de voz plana, local e campos de formato sob |
| output | Os itens produzidos pela resposta ao vivo. |
Propriedades herdadas
| conversation_id | A conversa à qual a resposta é adicionada, determinada pelo |
| id | O ID único da resposta será . |
| 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 |
| output_modalities | O conjunto de modalidades que o modelo usou para responder, atualmente os únicos valores possíveis são |
| status | O status final da resposta ( |
| 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
audio
A configuração de áudio usada pela resposta ao vivo, incluindo provedor de voz plana, local e campos de formato sob output.
audio?: VoiceResponseAudioValor da propriedade
output
Os itens produzidos pela resposta ao vivo.
output?: RealtimeConversationItemUnion[]Valor da propriedade
Detalhes das propriedades herdadas
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?: stringValor da propriedade
string
id
O ID único da resposta será .resp_1234
id?: stringValor da 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 nessa resposta.
max_output_tokens?: number | "inf"Valor da propriedade
number | "inf"
metadata
Pares chave-valor personalizados de string associados à resposta.
metadata?: MetadataValor da propriedade
Herdado deVoiceAgentRealtimeResponseBase.metadata
object
O tipo de objeto deve ser realtime.response.
object?: "realtime.response"Valor da 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 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"
Herdado deVoiceAgentRealtimeResponseBase.status
status_details
Detalhes adicionais sobre o status.
status_details?: RealtimeResponseStatusDetailsValor da propriedade
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?: RealtimeResponseUsageValor da propriedade
Herdado deVoiceAgentRealtimeResponseBase.usage