VoiceResponse interface

Una respuesta de voz persistente que representa un giro de inferencia de modelo dentro de una conversación. En los resultados de la lista la output proyección puede omitirse; recuperar la respuesta completa (GET .../responses/{response_id}) o la ruta de los ítems de respuesta paginados (GET .../responses/{response_id}/items) para sus elementos de salida. created_at / completed_at son extensiones duraderas de ordenación de Foundry.

Propiedades

audio

La configuración de audio utilizada para la respuesta, incluyendo la voz y el formato de audio usados para la salida.

completed_at

La marca de tiempo de Unix (en segundos) para cuando se completó la respuesta.

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

created_at

La marca de tiempo de Unix (en segundos) para cuando se creó la respuesta.

id

El ID único de la respuesta será resp_1234.

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 realtime.response.

output

La lista de elementos de salida generados por la respuesta.

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.

status

El estado final de la respuesta (completed, cancelled, failed, o incomplete, in_progress).

status_details

Detalles adicionales sobre el estado.

temperature

La temperatura de muestreo utilizada para la respuesta.

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

audio

La configuración de audio utilizada para la respuesta, incluyendo la voz y el formato de audio usados para la salida.

audio?: VoiceResponseAudio

Valor de propiedad

completed_at

La marca de tiempo de Unix (en segundos) para cuando se completó la respuesta.

completed_at?: Date

Valor de propiedad

Date

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?: string

Valor de propiedad

string

created_at

La marca de tiempo de Unix (en segundos) para cuando se creó la respuesta.

created_at?: Date

Valor de propiedad

Date

id

El ID único de la respuesta será resp_1234.

id?: string

Valor 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?: Metadata

Valor de propiedad

object

El tipo de objeto, debe ser realtime.response.

object?: "realtime.response"

Valor de propiedad

"realtime.response"

output

La lista de elementos de salida generados por la respuesta.

output?: RealtimeConversationItemUnion[]

Valor de propiedad

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?: RealtimeResponseStatusDetails

Valor de propiedad

temperature

La temperatura de muestreo utilizada para la respuesta.

temperature?: number

Valor de propiedad

number

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

Valor de propiedad