BetaVoiceAgentsConversationsOperations interface

Pacote:

@azure/ai-projects

Operações para gerenciar conversas de agentes de voz.

Propriedades

delete	Exclui uma conversa e todos os seus dados armazenados — respostas, itens e qualquer áudio (cascata). Este é o controle explícito de exclusão de dados do cliente para conversas de voz.
downloadAudio	Transmite a gravação estéreo mesclada de chamada inteira como um fluxo de bytes WAV (audio/wav) pelo serviço (sem URL SAS). Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de transporte de armazenamento próprio (BYOS), os bytes não são proxiados — o chamador deve baixar diretamente do armazenamento do cliente usando a blob_uri rota retornada pelo metadado — então essa rota retorna 409 Conflict para gravações BYOS. Enquanto a conversa é in_progress, essa rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando a orientação de retry estiver disponível. Quando a conversa é failed, ela retorna terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, o conteúdo está disponível sujeito ao comportamento existente do BYOT. Uma conversa sem áudio persistente (store = false) retorna 404.
downloadAudioItem	Transmite o áudio de um único item de conversa como um stream de bytes WAV (audio/wav) pelo serviço (sem URL SAS). Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxyados — o chamador deve baixar diretamente do armazenamento do cliente usando a blob_uri rota de metadados retornada pelo item /audio — então essa rota retorna 409 Conflict para gravações BYOS. Retorna 404 quando a conversa, item ou seu áudio não foi mantido (store = false).
downloadGeneratedAudioItem	Transmite o áudio gerado por um item de conversa como um fluxo de bytes WAV (audio/wav) através do serviço. Esse artefato subordinado existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, inclusive quando a resposta termina como cancelada. Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxy, então essa rota retorna 409 Conflict. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado além do segmento ouvido.
get	Recupera uma única conversa gravada para o endpoint do agente de voz especificado pelo seu id. Retorna 404 quando a conversa não foi persistida (store = false) ou não existe.
getAudio	Retorna metadados para a gravação estéreo mesclada de toda a chamada (áudio do usuário no canal esquerdo, áudio do agente no direito). Os metadados comuns (formato, taxa de amostragem, canais, layout do canal, duração) são retornados tanto para gravações gerenciadas pela Foundry quanto para gravações de transporte de armazenamento próprio (BYOS); para BYOS, a resposta inclui blob_uriadicionalmente , o URI da gravação no armazenamento próprio do cliente (sem SAS) que o cliente baixa com suas próprias credenciais. A gravação é construída uma vez a partir dos segmentos por turno após o sucesso da finalização da persistência. Enquanto a conversa é in_progress, essa rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando a orientação de retry estiver disponível. Quando a conversa é failed, ela retorna terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, os metadados estão disponíveis sujeitos ao comportamento existente do BYOT. Requer que a conversa tenha áudio persistente (store = true); caso contrário, retorna 404.
getAudioItem	Retorna metadados para o segmento de áudio de um único item de conversa, incluindo os fatos comuns de reprodução (papel, formato/codec, taxa de amostragem, canais, deslocamento, duração) tanto para gravações gerenciadas pela Foundry quanto para gravações de transporte de armazenamento (BYOS); para BYOS, a resposta inclui blob_uriadicionalmente , o URI da gravação no armazenamento próprio do cliente (sem SAS) que o cliente baixa com suas próprias credenciais. Requer que a conversa tenha áudio persistente (store = true); retorna 404 quando a conversa, item ou seu áudio não foi persistido.
getGeneratedAudioItem	Retorna metadados do áudio gerado por um item de conversa. Esse artefato subordinado é separado do segmento canônico de áudio ouvido e existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, inclusive quando a resposta termina como cancelada. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado além do segmento ouvido.
getItem	Recupera um único item da conversa especificada pelo seu id, incluindo sua transcrição. Uma input_audio/output_audio parte de conteúdo indica que o áudio está disponível para o item; os metadados canônicos de áudio por item são o /items/{item_id}/audio recurso, e os bytes são transmitidos por ./items/{item_id}/audio/content Retorna 404 quando a conversa ou item não foi mantida (store = false).
getResponse	Recupera uma única resposta da conversa especificada por seu id, incluindo seus output itens, usage, e status. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).
list	Retorna as conversas que persistiram para o endpoint do agente de voz especificado. As conversas estão presentes quando a configuração efetiva store da sessão é true, seja herdada da definição do agente ou habilitada pelo override da sessão WebSocket.
listItems	Retorna uma coleção paginada de itens — o histórico completo de conversas ordenado, incluindo entrada do usuário, saída do assistente e saídas de ferramentas criadas pelo cliente (transcrições + eventos da ferramenta). Retorna 404 quando a conversa não foi mantida (store = false).
listResponseItems	Retorna uma coleção paginada dos itens de saída produzidos por uma resposta específica (a projeção de saída da resposta). Para o histórico completo de conversas ordenado — incluindo entrada do usuário e saídas de ferramentas criadas pelo cliente — use a rota dos itens de conversa. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).
listResponses	Retorna uma coleção paginada das respostas (reviravoltas de inferência do modelo) registradas para a conversa especificada. A projeção por resposta output pode ser omitida aqui; use a rota dos itens de resposta para a saída paginada canônica. Retorna 404 quando a conversa não foi mantida (store = false).

Detalhes da propriedade

delete

Exclui uma conversa e todos os seus dados armazenados — respostas, itens e qualquer áudio (cascata). Este é o controle explícito de exclusão de dados do cliente para conversas de voz.

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

Valor da propriedade

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

downloadAudio

Transmite a gravação estéreo mesclada de chamada inteira como um fluxo de bytes WAV (audio/wav) pelo serviço (sem URL SAS). Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de transporte de armazenamento próprio (BYOS), os bytes não são proxiados — o chamador deve baixar diretamente do armazenamento do cliente usando a blob_uri rota retornada pelo metadado — então essa rota retorna 409 Conflict para gravações BYOS. Enquanto a conversa é in_progress, essa rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando a orientação de retry estiver disponível. Quando a conversa é failed, ela retorna terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, o conteúdo está disponível sujeito ao comportamento existente do BYOT. Uma conversa sem áudio persistente (store = false) retorna 404.

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

Valor da propriedade

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

downloadAudioItem

Transmite o áudio de um único item de conversa como um stream de bytes WAV (audio/wav) pelo serviço (sem URL SAS). Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxyados — o chamador deve baixar diretamente do armazenamento do cliente usando a blob_uri rota de metadados retornada pelo item /audio — então essa rota retorna 409 Conflict para gravações BYOS. Retorna 404 quando a conversa, item ou seu áudio não foi mantido (store = false).

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

Valor da propriedade

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

downloadGeneratedAudioItem

Transmite o áudio gerado por um item de conversa como um fluxo de bytes WAV (audio/wav) através do serviço. Esse artefato subordinado existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, inclusive quando a resposta termina como cancelada. Esta rota atende apenas armazenamento gerenciado pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxy, então essa rota retorna 409 Conflict. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado além do segmento ouvido.

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

Valor da propriedade

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

get

Recupera uma única conversa gravada para o endpoint do agente de voz especificado pelo seu id. Retorna 404 quando a conversa não foi persistida (store = false) ou não existe.

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

Valor da propriedade

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

getAudio

Retorna metadados para a gravação estéreo mesclada de toda a chamada (áudio do usuário no canal esquerdo, áudio do agente no direito). Os metadados comuns (formato, taxa de amostragem, canais, layout do canal, duração) são retornados tanto para gravações gerenciadas pela Foundry quanto para gravações de transporte de armazenamento próprio (BYOS); para BYOS, a resposta inclui blob_uriadicionalmente , o URI da gravação no armazenamento próprio do cliente (sem SAS) que o cliente baixa com suas próprias credenciais. A gravação é construída uma vez a partir dos segmentos por turno após o sucesso da finalização da persistência. Enquanto a conversa é in_progress, essa rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando a orientação de retry estiver disponível. Quando a conversa é failed, ela retorna terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, os metadados estão disponíveis sujeitos ao comportamento existente do BYOT. Requer que a conversa tenha áudio persistente (store = true); caso contrário, retorna 404.

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

Valor da propriedade

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

getAudioItem

Retorna metadados para o segmento de áudio de um único item de conversa, incluindo os fatos comuns de reprodução (papel, formato/codec, taxa de amostragem, canais, deslocamento, duração) tanto para gravações gerenciadas pela Foundry quanto para gravações de transporte de armazenamento (BYOS); para BYOS, a resposta inclui blob_uriadicionalmente , o URI da gravação no armazenamento próprio do cliente (sem SAS) que o cliente baixa com suas próprias credenciais. Requer que a conversa tenha áudio persistente (store = true); retorna 404 quando a conversa, item ou seu áudio não foi persistido.

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

Valor da propriedade

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

getGeneratedAudioItem

Retorna metadados do áudio gerado por um item de conversa. Esse artefato subordinado é separado do segmento canônico de áudio ouvido e existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, inclusive quando a resposta termina como cancelada. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado além do segmento ouvido.

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

Valor da propriedade

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

getItem

Recupera um único item da conversa especificada pelo seu id, incluindo sua transcrição. Uma input_audio/output_audio parte de conteúdo indica que o áudio está disponível para o item; os metadados canônicos de áudio por item são o /items/{item_id}/audio recurso, e os bytes são transmitidos por ./items/{item_id}/audio/content Retorna 404 quando a conversa ou item não foi mantida (store = false).

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

Valor da propriedade

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

getResponse

Recupera uma única resposta da conversa especificada por seu id, incluindo seus output itens, usage, e status. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).

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

Valor da propriedade

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

list

Retorna as conversas que persistiram para o endpoint do agente de voz especificado. As conversas estão presentes quando a configuração efetiva store da sessão é true, seja herdada da definição do agente ou habilitada pelo override da sessão WebSocket.

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

Valor da propriedade

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

listItems

Retorna uma coleção paginada de itens — o histórico completo de conversas ordenado, incluindo entrada do usuário, saída do assistente e saídas de ferramentas criadas pelo cliente (transcrições + eventos da ferramenta). Retorna 404 quando a conversa não foi mantida (store = false).

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

Valor da propriedade

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

listResponseItems

Retorna uma coleção paginada dos itens de saída produzidos por uma resposta específica (a projeção de saída da resposta). Para o histórico completo de conversas ordenado — incluindo entrada do usuário e saídas de ferramentas criadas pelo cliente — use a rota dos itens de conversa. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).

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

Valor da propriedade

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

listResponses

Retorna uma coleção paginada das respostas (reviravoltas de inferência do modelo) registradas para a conversa especificada. A projeção por resposta output pode ser omitida aqui; use a rota dos itens de resposta para a saída paginada canônica. Retorna 404 quando a conversa não foi mantida (store = false).

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

Valor da propriedade

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