BetaVoiceAgentsConversationsOperations interface

Pacote:

@azure/ai-projects

Operações para gerir conversas com agentes de voz.

Propriedades

delete	Apaga uma conversa e todos os seus dados armazenados — respostas, itens e qualquer áudio (cascata). Este é o controlo explícito de eliminação de dados do cliente para conversas de voz.
downloadAudio	Transmite a gravação estéreo fundida da chamada inteira como um fluxo de bytes WAV (audio/wav) através do serviço (sem URL SAS). Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxyados — o chamador deve descarregar diretamente do armazenamento do cliente usando a blob_uri rota retornada pela metadata — pelo que esta rota retorna 409 Conflict para gravações BYOS. Enquanto a conversa é in_progress, esta rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando há orientação de retentativa disponível. Quando a conversa é failed, devolve terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, o conteúdo está disponível sujeito ao comportamento existente do BYOS. Uma conversa sem áudio persistente (store = false) retorna 404.
downloadAudioItem	Transmite o áudio de um único elemento de conversa como um fluxo de bytes WAV (audio/wav) através do serviço (sem URL SAS). Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações bring-your-own-storage (BYOS), os bytes não são proxyed — o chamador deve descarregar diretamente do armazenamento do cliente usando a blob_uri rota de metadados retornada pelo /audio item — pelo que esta rota retorna 409 Conflict para gravações BYOS. Retorna 404 quando a conversa, o item ou o seu áudio não foram mantidos (store = false).
downloadGeneratedAudioItem	Transmite o áudio gerado por um item de conversa como um stream de bytes WAV (audio/wav) através do serviço. Este artefacto subordinado existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, incluindo quando a resposta termina como cancelada. Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações de transporte do seu próprio armazenamento (BYOS), os bytes não são proxy, pelo que esta rota devolve 409 Conflict. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado para 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	Devolve metadados para a gravação estéreo fundida de toda a chamada (áudio do utilizador no canal esquerdo, áudio do agente no direito). Os metadados comuns (formato, taxa de amostragem, canais, disposição do canal, duração) são devolvidos tanto para gravações geridas pela Foundry como para gravações 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 descarrega com as 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, esta rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando há orientação de retentativa disponível. Quando a conversa é failed, devolve terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, os metadados estão disponíveis, sujeitos ao comportamento existente do BYOS. Requer que a conversa tenha áudio persistente (store = true); caso contrário, retorna 404.
getAudioItem	Devolve metadados para o segmento áudio de um único item de conversa, incluindo os factos comuns de reprodução (papel, formato/codec, taxa de amostragem, canais, deslocamento, duração) tanto para gravações geridas pela Foundry como 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 descarrega com as suas próprias credenciais. Requer que a conversa tenha persistido áudio (store = true); retorna 404 quando a conversa, item ou o seu áudio não foi persistido.
getGeneratedAudioItem	Devolve metadados do áudio gerado por um item de conversa. Este artefacto 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, incluindo quando a resposta termina como cancelada. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado para além do segmento ouvido.
getItem	Recupera um único item da conversa especificada pelo seu id, incluindo a 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 o item não foi mantido (store = false).
getResponse	Recupera uma única resposta da conversa especificada pelo seu id, incluindo os seus output elementos, usage, e estado. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).
list	Devolve as conversas que persistiram para o endpoint do agente de voz especificado. As conversas estão presentes quando a definição efetiva store da sessão é true, quer herdada da definição do agente quer habilitada pelo sobrescrito da sessão WebSocket.
listItems	Devolve uma coleção paginada de itens — o histórico completo de conversas ordenado, incluindo entrada do utilizador, 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	Devolve 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 utilizador e saídas de ferramentas criadas pelo cliente — use antes a rota dos itens de conversa. Retorna 404 quando a conversa ou resposta não foi mantida (store = false).
listResponses	Devolve uma coleção paginada das respostas (reviravoltas de inferência do modelo) gravadas 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 de Propriedade

delete

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

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

Valor de Propriedade

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

downloadAudio

Transmite a gravação estéreo fundida da chamada inteira como um fluxo de bytes WAV (audio/wav) através do serviço (sem URL SAS). Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações de armazenamento próprio (BYOS), os bytes não são proxyados — o chamador deve descarregar diretamente do armazenamento do cliente usando a blob_uri rota retornada pela metadata — pelo que esta rota retorna 409 Conflict para gravações BYOS. Enquanto a conversa é in_progress, esta rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando há orientação de retentativa disponível. Quando a conversa é failed, devolve terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, o conteúdo está disponível sujeito ao comportamento existente do BYOS. Uma conversa sem áudio persistente (store = false) retorna 404.

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

Valor de Propriedade

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

downloadAudioItem

Transmite o áudio de um único elemento de conversa como um fluxo de bytes WAV (audio/wav) através do serviço (sem URL SAS). Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações bring-your-own-storage (BYOS), os bytes não são proxyed — o chamador deve descarregar diretamente do armazenamento do cliente usando a blob_uri rota de metadados retornada pelo /audio item — pelo que esta rota retorna 409 Conflict para gravações BYOS. Retorna 404 quando a conversa, o item ou o seu áudio não foram mantidos (store = false).

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

Valor de Propriedade

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

downloadGeneratedAudioItem

Transmite o áudio gerado por um item de conversa como um stream de bytes WAV (audio/wav) através do serviço. Este artefacto subordinado existe apenas quando a reprodução foi interrompida e o serviço forneceu mais áudio do que o ouvinte ouviu, incluindo quando a resposta termina como cancelada. Esta rota serve apenas armazenamento gerido pela Foundry. Para gravações de transporte do seu próprio armazenamento (BYOS), os bytes não são proxy, pelo que esta rota devolve 409 Conflict. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado para além do segmento ouvido.

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

Valor de 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 de Propriedade

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

getAudio

Devolve metadados para a gravação estéreo fundida de toda a chamada (áudio do utilizador no canal esquerdo, áudio do agente no direito). Os metadados comuns (formato, taxa de amostragem, canais, disposição do canal, duração) são devolvidos tanto para gravações geridas pela Foundry como para gravações 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 descarrega com as 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, esta rota retorna retryable 409 Conflict com error.code = recording_not_ready e um Retry-After cabeçalho quando há orientação de retentativa disponível. Quando a conversa é failed, devolve terminal 409 Conflict com error.code = recording_unavailable. Para uma completed conversa, os metadados estão disponíveis, sujeitos ao comportamento existente do BYOS. Requer que a conversa tenha áudio persistente (store = true); caso contrário, retorna 404.

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

Valor de Propriedade

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

getAudioItem

Devolve metadados para o segmento áudio de um único item de conversa, incluindo os factos comuns de reprodução (papel, formato/codec, taxa de amostragem, canais, deslocamento, duração) tanto para gravações geridas pela Foundry como 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 descarrega com as suas próprias credenciais. Requer que a conversa tenha persistido áudio (store = true); retorna 404 quando a conversa, item ou o seu áudio não foi persistido.

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

Valor de Propriedade

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

getGeneratedAudioItem

Devolve metadados do áudio gerado por um item de conversa. Este artefacto 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, incluindo quando a resposta termina como cancelada. Retorna 404 quando a conversa ou item não foi mantido, ou quando não existe áudio gerado para além do segmento ouvido.

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

Valor de Propriedade

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

getItem

Recupera um único item da conversa especificada pelo seu id, incluindo a 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 o item não foi mantido (store = false).

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

Valor de Propriedade

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

getResponse

Recupera uma única resposta da conversa especificada pelo seu id, incluindo os seus output elementos, usage, e estado. 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 de Propriedade

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

list

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

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

Valor de Propriedade

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

listItems

Devolve uma coleção paginada de itens — o histórico completo de conversas ordenado, incluindo entrada do utilizador, 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 de Propriedade

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

listResponseItems

Devolve 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 utilizador e saídas de ferramentas criadas pelo cliente — use antes 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 de Propriedade

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

listResponses

Devolve uma coleção paginada das respostas (reviravoltas de inferência do modelo) gravadas 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 de Propriedade

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