BetaVoiceAgentsConversationsOperations interface

Operaciones para gestionar conversaciones de agentes de voz.

Propiedades

delete

Elimina una conversación y todos sus datos almacenados — respuestas, elementos y cualquier audio (cascada). Este es el control explícito de eliminación de datos del cliente para conversaciones de voz.

downloadAudio

Transmite la grabación estéreo fusionada de llamada completa como un flujo de bytes WAV (audio/wav) a través del servicio (sin URL SAS). Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para las grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxyados — el llamante debe descargar directamente desde el almacenamiento del cliente usando la blob_uri ruta retornada por metadatos — por lo que esta ruta se retorna 409 Conflict para las grabaciones BYOS. Mientras la conversación es in_progress, esta ruta devuelve retryable 409 Conflict con error.code = recording_not_ready y un Retry-After encabezado cuando hay guía de reintento disponible. Cuando la conversación es failed, devuelve terminal 409 Conflict con error.code = recording_unavailable. Para una completed conversación, el contenido está disponible sujeto al comportamiento existente en BYOT. Una conversación sin audio persistente (store = false) devuelve 404.

downloadAudioItem

Transmite el audio de un solo elemento de conversación como un flujo de bytes WAV (audio/wav) a través del servicio (sin URL SAS). Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para las grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxyados — el llamante debe descargar directamente desde el almacenamiento del cliente usando la blob_uri ruta de metadatos retornada por el /audio elemento — por lo que esta ruta se retorna 409 Conflict para grabaciones BYOS. Retorna 404 cuando la conversación, el elemento o su audio no se han mantenido (store = false).

downloadGeneratedAudioItem

Transmite el audio generado por un elemento de conversación como un flujo de bytes WAV (audio/wav) a través del servicio. Este artefacto subordinado solo existe cuando la reproducción se interrumpe y el servicio emite más audio del que el oyente escuchó, incluso cuando la respuesta termina como cancelada. Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxy, por lo que esta ruta devuelve 409 Conflict. Vuelve 404 cuando la conversación o el elemento no se ha continuado, o cuando no existe audio generado más allá del segmento escuchado.

get

Recupera una única conversación grabada para el endpoint del agente de voz especificado por su id. Devuelve 404 cuando la conversación no se ha continuado (store = false) o no existe.

getAudio

Devuelve metadatos para la grabación estéreo combinada de toda la llamada (audio del usuario en el canal izquierdo, audio del agente en el derecho). Los metadatos comunes (formato, tasa de muestreo, canales, disposición del canal, duración) se devuelven tanto para grabaciones gestionadas por Foundry como para grabaciones de traer tu propio almacenamiento (BYOS); para BYOS, la respuesta incluye blob_uriademás , el URI de la grabación en el almacenamiento propio del cliente (sin SAS) que el cliente descarga con sus propias credenciales. La grabación se construye una vez a partir de los segmentos por turno tras el éxito de la finalización de persistencia. Mientras la conversación es in_progress, esta ruta devuelve retryable 409 Conflict con error.code = recording_not_ready y un Retry-After encabezado cuando hay guía de reintento disponible. Cuando la conversación es failed, devuelve terminal 409 Conflict con error.code = recording_unavailable. Para una completed conversación, los metadatos están disponibles sujetos al comportamiento existente de BYOS. Requiere que la conversación tenga audio persistente (store = true); de lo contrario, devuelve 404.

getAudioItem

Devuelve metadatos para el segmento de audio de un solo elemento de conversación, incluyendo los datos comunes de reproducción (rol, formato/códec, frecuencia de muestreo, canales, desplazamiento, duración) tanto para grabaciones gestionadas por Foundry como para grabaciones de traer tu propio almacenamiento (BYOS); para BYOS la respuesta incluye blob_uriademás , el URI de la grabación en el almacenamiento propio del cliente (sin SAS) que el cliente descarga con sus propias credenciales. Requiere que la conversación haya contenido de audio persistente (store = true); devuelve 404 cuando la conversación, el elemento o su audio no se ha continuado.

getGeneratedAudioItem

Devuelve metadatos del audio generado por un elemento de conversación. Este artefacto subordinado es independiente del segmento canónico de audio audido y existe solo cuando la reproducción se interrumpe y el servicio emite más audio del que el oyente escuchó, incluyendo cuando la respuesta termina como cancelada. Vuelve 404 cuando la conversación o el elemento no se ha continuado, o cuando no existe audio generado más allá del segmento escuchado.

getItem

Recupera un único elemento de la conversación especificada mediante su id, incluyendo su transcripción. Una parte de contenido indica que hay audio disponible para el elemento; los metadatos canónicos input_audiooutput_audio/de audio por elemento son el /items/{item_id}/audio recurso, y los bytes son transmitidos por /items/{item_id}/audio/content. Retorna 404 cuando la conversación o el elemento no se han mantenido (store = false).

getResponse

Recupera una única respuesta de la conversación especificada mediante su id, incluyendo sus output elementos, usage, y estado. Retorna 404 cuando la conversación o respuesta no se ha mantenido (store = false).

list

Devuelve las conversaciones que persistieron para el endpoint del agente de voz especificado. Las conversaciones están presentes cuando la configuración efectiva store de la sesión es true, ya sea heredada de la definición del agente o habilitada por la anulación de sesión WebSocket.

listItems

Devuelve una colección paginada de elementos — el historial completo ordenado de conversaciones, incluyendo la entrada del usuario, la salida del asistente y las salidas de herramientas creadas por el cliente (transcripciones + eventos de herramienta). Retorna 404 cuando la conversación no se mantuvo (store = false).

listResponseItems

Devuelve una colección paginada de los elementos de salida producidos por una respuesta específica (la proyección de salida de la respuesta). Para el historial completo de conversaciones ordenadas — incluyendo la entrada del usuario y las salidas de herramientas creadas por el cliente — utiliza la ruta de los elementos de conversación. Retorna 404 cuando la conversación o respuesta no se ha mantenido (store = false).

listResponses

Devuelve una colección paginada de las respuestas (cambios de inferencia del modelo) registradas para la conversación especificada. La proyección por respuesta output puede omitirse aquí; utiliza la ruta de los ítems de respuesta para la salida paginada canónica. Retorna 404 cuando la conversación no se mantuvo (store = false).

Detalles de las propiedades

delete

Elimina una conversación y todos sus datos almacenados — respuestas, elementos y cualquier audio (cascada). Este es el control explícito de eliminación de datos del cliente para conversaciones de voz.

delete: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>

downloadAudio

Transmite la grabación estéreo fusionada de llamada completa como un flujo de bytes WAV (audio/wav) a través del servicio (sin URL SAS). Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para las grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxyados — el llamante debe descargar directamente desde el almacenamiento del cliente usando la blob_uri ruta retornada por metadatos — por lo que esta ruta se retorna 409 Conflict para las grabaciones BYOS. Mientras la conversación es in_progress, esta ruta devuelve retryable 409 Conflict con error.code = recording_not_ready y un Retry-After encabezado cuando hay guía de reintento disponible. Cuando la conversación es failed, devuelve terminal 409 Conflict con error.code = recording_unavailable. Para una completed conversación, el contenido está disponible sujeto al comportamiento existente en BYOT. Una conversación sin audio persistente (store = false) devuelve 404.

downloadAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>

downloadAudioItem

Transmite el audio de un solo elemento de conversación como un flujo de bytes WAV (audio/wav) a través del servicio (sin URL SAS). Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para las grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxyados — el llamante debe descargar directamente desde el almacenamiento del cliente usando la blob_uri ruta de metadatos retornada por el /audio elemento — por lo que esta ruta se retorna 409 Conflict para grabaciones BYOS. Retorna 404 cuando la conversación, el elemento o su audio no se han mantenido (store = false).

downloadAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>

Valor de propiedad

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>

downloadGeneratedAudioItem

Transmite el audio generado por un elemento de conversación como un flujo de bytes WAV (audio/wav) a través del servicio. Este artefacto subordinado solo existe cuando la reproducción se interrumpe y el servicio emite más audio del que el oyente escuchó, incluso cuando la respuesta termina como cancelada. Esta ruta sirve únicamente para almacenamiento gestionado por Foundry. Para grabaciones de traer tu propio almacenamiento (BYOS), los bytes no están proxy, por lo que esta ruta devuelve 409 Conflict. Vuelve 404 cuando la conversación o el elemento no se ha continuado, o cuando no existe audio generado más allá del segmento escuchado.

downloadGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>

Valor de propiedad

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>

get

Recupera una única conversación grabada para el endpoint del agente de voz especificado por su id. Devuelve 404 cuando la conversación no se ha continuado (store = false) o no existe.

get: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>

getAudio

Devuelve metadatos para la grabación estéreo combinada de toda la llamada (audio del usuario en el canal izquierdo, audio del agente en el derecho). Los metadatos comunes (formato, tasa de muestreo, canales, disposición del canal, duración) se devuelven tanto para grabaciones gestionadas por Foundry como para grabaciones de traer tu propio almacenamiento (BYOS); para BYOS, la respuesta incluye blob_uriademás , el URI de la grabación en el almacenamiento propio del cliente (sin SAS) que el cliente descarga con sus propias credenciales. La grabación se construye una vez a partir de los segmentos por turno tras el éxito de la finalización de persistencia. Mientras la conversación es in_progress, esta ruta devuelve retryable 409 Conflict con error.code = recording_not_ready y un Retry-After encabezado cuando hay guía de reintento disponible. Cuando la conversación es failed, devuelve terminal 409 Conflict con error.code = recording_unavailable. Para una completed conversación, los metadatos están disponibles sujetos al comportamiento existente de BYOS. Requiere que la conversación tenga audio persistente (store = true); de lo contrario, devuelve 404.

getAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>

getAudioItem

Devuelve metadatos para el segmento de audio de un solo elemento de conversación, incluyendo los datos comunes de reproducción (rol, formato/códec, frecuencia de muestreo, canales, desplazamiento, duración) tanto para grabaciones gestionadas por Foundry como para grabaciones de traer tu propio almacenamiento (BYOS); para BYOS la respuesta incluye blob_uriademás , el URI de la grabación en el almacenamiento propio del cliente (sin SAS) que el cliente descarga con sus propias credenciales. Requiere que la conversación haya contenido de audio persistente (store = true); devuelve 404 cuando la conversación, el elemento o su audio no se ha continuado.

getAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>

Valor de propiedad

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>

getGeneratedAudioItem

Devuelve metadatos del audio generado por un elemento de conversación. Este artefacto subordinado es independiente del segmento canónico de audio audido y existe solo cuando la reproducción se interrumpe y el servicio emite más audio del que el oyente escuchó, incluyendo cuando la respuesta termina como cancelada. Vuelve 404 cuando la conversación o el elemento no se ha continuado, o cuando no existe audio generado más allá del segmento escuchado.

getGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>

Valor de propiedad

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>

getItem

Recupera un único elemento de la conversación especificada mediante su id, incluyendo su transcripción. Una parte de contenido indica que hay audio disponible para el elemento; los metadatos canónicos input_audiooutput_audio/de audio por elemento son el /items/{item_id}/audio recurso, y los bytes son transmitidos por /items/{item_id}/audio/content. Retorna 404 cuando la conversación o el elemento no se han mantenido (store = false).

getItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>

Valor de propiedad

(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>

getResponse

Recupera una única respuesta de la conversación especificada mediante su id, incluyendo sus output elementos, usage, y estado. Retorna 404 cuando la conversación o respuesta no se ha mantenido (store = false).

getResponse: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>

Valor de propiedad

(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>

list

Devuelve las conversaciones que persistieron para el endpoint del agente de voz especificado. Las conversaciones están presentes cuando la configuración efectiva store de la sesión es true, ya sea heredada de la definición del agente o habilitada por la anulación de sesión WebSocket.

list: (agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>

Valor de propiedad

(agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>

listItems

Devuelve una colección paginada de elementos — el historial completo ordenado de conversaciones, incluyendo la entrada del usuario, la salida del asistente y las salidas de herramientas creadas por el cliente (transcripciones + eventos de herramienta). Retorna 404 cuando la conversación no se mantuvo (store = false).

listItems: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

listResponseItems

Devuelve una colección paginada de los elementos de salida producidos por una respuesta específica (la proyección de salida de la respuesta). Para el historial completo de conversaciones ordenadas — incluyendo la entrada del usuario y las salidas de herramientas creadas por el cliente — utiliza la ruta de los elementos de conversación. Retorna 404 cuando la conversación o respuesta no se ha mantenido (store = false).

listResponseItems: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

Valor de propiedad

(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>

listResponses

Devuelve una colección paginada de las respuestas (cambios de inferencia del modelo) registradas para la conversación especificada. La proyección por respuesta output puede omitirse aquí; utiliza la ruta de los ítems de respuesta para la salida paginada canónica. Retorna 404 cuando la conversación no se mantuvo (store = false).

listResponses: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>

Valor de propiedad

(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>