VoiceAgentRealtimeResponseBase interface
Propiedades compartidas por respuestas en tiempo real devueltas por el servicio de agente de voz.
Propiedades
| conversation_id | A qué conversación se añade la respuesta, determinada por el |
| id | El ID único de la respuesta será |
| max_output_tokens | Número máximo de tokens de salida para una respuesta de un solo asistente, incluyendo llamadas a herramientas, que se utilizó en esta respuesta. |
| metadata | Pares clave-valor de cadenas personalizados asociados a la respuesta. |
| object | El tipo de objeto, debe ser |
| output_modalities | El conjunto de modalidades que el modelo usó para responder, actualmente los únicos valores posibles son |
| status | El estado final de la respuesta ( |
| status_details | Detalles adicionales sobre el estado. |
| usage | Estadísticas de uso para la Respuesta, esto corresponderá a la facturación. Una sesión de API en tiempo real mantendrá un contexto de conversación y añadirá nuevos elementos a la conversación, por lo que la salida de turnos anteriores (tokens de texto y audio) se convertirá en la entrada para turnos posteriores. |
Detalles de las propiedades
conversation_id
A qué conversación se añade la respuesta, determinada por el conversation campo del response.create evento. Si auto, la respuesta se añadirá a la conversación predeterminada y el valor de conversation_id será un id como conv_1234. Si none, la respuesta no se añadirá a ninguna conversación y el valor de conversation_id será null. Si las respuestas se activan automáticamente por el VAD, la respuesta se añadirá a la conversación predeterminada
conversation_id?: stringValor de propiedad
string
id
El ID único de la respuesta será resp_1234.
id?: stringValor de propiedad
string
max_output_tokens
Número máximo de tokens de salida para una respuesta de un solo asistente, incluyendo llamadas a herramientas, que se utilizó en esta respuesta.
max_output_tokens?: number | "inf"Valor de propiedad
number | "inf"
metadata
Pares clave-valor de cadenas personalizados asociados a la respuesta.
metadata?: MetadataValor de propiedad
object
El tipo de objeto, debe ser realtime.response.
object?: "realtime.response"Valor de propiedad
"realtime.response"
output_modalities
El conjunto de modalidades que el modelo usó para responder, actualmente los únicos valores posibles son [\"audio\"], [\"text\"]. La salida de audio siempre incluye una transcripción de texto. Poner la salida en modo text desactivará la salida de audio del modelo.
output_modalities?: ("text" | "audio")[]Valor de propiedad
("text" | "audio")[]
status
El estado final de la respuesta (completed, cancelled, failed, o incomplete, in_progress).
status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"Valor de propiedad
"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"
status_details
Detalles adicionales sobre el estado.
status_details?: RealtimeResponseStatusDetailsValor de propiedad
usage
Estadísticas de uso para la Respuesta, esto corresponderá a la facturación. Una sesión de API en tiempo real mantendrá un contexto de conversación y añadirá nuevos elementos a la conversación, por lo que la salida de turnos anteriores (tokens de texto y audio) se convertirá en la entrada para turnos posteriores.
usage?: RealtimeResponseUsage