BetaVoiceAgentsConversationsOperations interface

Pacchetto:

@azure/ai-projects

Operazioni per la gestione delle conversazioni degli agenti vocali.

Proprietà

delete	Elimina una conversazione e tutti i suoi dati memorizzati — risposte, elementi e qualsiasi audio (cascata). Questo è il controllo esplicito della cancellazione dei dati per le conversazioni vocali del cliente.
downloadAudio	Trasmette la registrazione stereo unita dell'intera chiamata come un flusso di byte WAV (audio/wav) attraverso il servizio (senza URL SAS). Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-own-storage (BYOS) i byte non sono proxy — il chiamante deve scaricare direttamente dallo storage del cliente utilizzando la blob_uri via restituita dai metadati — quindi questa route ritorna 409 Conflict per le registrazioni BYOS. Mentre la conversazione è in_progress, questa via restituisce il ritentabile 409 Conflict con error.code = recording_not_ready e un'intestazione Retry-After quando è disponibile una guida per il ritento. Quando la conversazione è failed, restituisce terminale 409 Conflict con error.code = recording_unavailable. Per una completed conversazione, il contenuto è disponibile soggetto al comportamento BYOS esistente. Una conversazione senza audio persistente (store = false) restituisce 404.
downloadAudioItem	Trasmette in streaming l'audio di un singolo elemento di conversazione come flusso di byte WAV (audio/wav) attraverso il servizio (senza URL SAS). Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-your-own-storage (BYOS) i byte non sono proxy — il chiamante deve scaricare direttamente dallo storage del cliente utilizzando il blob_uri percorso di metadati restituito dall'articolo /audio — quindi questo percorso ritorna 409 Conflict per le registrazioni BYOS. Ritorni 404 quando la conversazione, l'oggetto o il suo audio non sono stati mantenuti (store = false).
downloadGeneratedAudioItem	Trasmette l'audio generato da un elemento di conversazione come flusso di byte WAV (audio/wav) attraverso il servizio. Questo artefatto subordinato esiste solo quando la riproduzione è stata interrotta e il servizio ha emesso più audio di quanto l'ascoltatore abbia percepito, incluso quando la risposta termina come cancellata. Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-own-storage (BYOS) i byte non sono proxy, quindi questa route restituisce 409 Conflict. Ritorna 404 quando la conversazione o l'elemento non sono stati proseguiti, o quando non esiste audio generato oltre il segmento ascoltato.
get	Recupera una singola conversazione registrata per l'endpoint dell'agente vocale specificato tramite il suo id. Restituisce 404 quando la conversazione non è stata proseguita (store = false) o non esiste.
getAudio	Restituisce i metadati per la registrazione stereo unita dell'intera chiamata (audio utente sul canale sinistro, audio agente su quello destro). I metadati comuni (formato, frequenza di campionamento, canali, disposizione del canale, durata) vengono restituiti sia per le registrazioni gestite da Foundry sia per quelle BYOS; per BYOS la risposta include blob_uriinoltre , l'URI della registrazione nello storage del cliente (senza SAS) che il cliente scarica con le proprie credenziali. La registrazione viene costruita una volta a partire dai segmenti per turno dopo che la finalizzazione della persistenza è riuscita. Mentre la conversazione è in_progress, questa via restituisce il ritentabile 409 Conflict con error.code = recording_not_ready e un'intestazione Retry-After quando è disponibile una guida per il ritento. Quando la conversazione è failed, restituisce terminale 409 Conflict con error.code = recording_unavailable. Per una completed conversazione, i metadati sono disponibili soggetti al comportamento BYOS esistente. Richiede che la conversazione abbia un audio persistente (store = true); altrimenti restituisce 404.
getAudioItem	Restituisce i metadati per il segmento audio di un singolo elemento di conversazione, inclusi i fatti comuni di riproduzione (ruolo, formato/codec, frequenza di campionamento, canali, offset, durata) sia per registrazioni gestite da Foundry che per quelle di bring-your-own-storage (BYOS); per BYOS la risposta include blob_uriinoltre , l'URI della registrazione nella memoria del cliente (senza SAS) che il cliente scarica con le proprie credenziali. Richiede che la conversazione abbia un audio persistente (store = true); ritorna 404 quando la conversazione, l'elemento o il suo audio non sono stati persistiti.
getGeneratedAudioItem	Restituisce i metadati per l'audio generato da un elemento di conversazione. Questo artefatto subordinato è separato dal segmento canonico audio-udito e esiste solo quando la riproduzione è stata interrotta e il servizio ha emesso più audio di quanto l'ascoltatore abbia sentito, incluso quando la risposta termina come cancellata. Ritorna 404 quando la conversazione o l'elemento non sono stati proseguiti, o quando non esiste audio generato oltre il segmento ascoltato.
getItem	Recupera un singolo elemento dalla conversazione specificata tramite il suo id, inclusa la trascrizione. Una input_audio/output_audio parte di contenuto indica che l'audio è disponibile per l'elemento; i metadati audio canonici per singolo elemento sono la /items/{item_id}/audio risorsa, e i byte sono trasmessi in streaming da ./items/{item_id}/audio/content Ritorni 404 quando la conversazione o l'articolo non sono stati proseguiti (store = false).
getResponse	Recupera una singola risposta dalla conversazione specificata tramite il suo id, inclusi i suoi output elementi, usage, e stato. Ritorna 404 quando la conversazione o la risposta non sono state proseguite (store = false).
list	Restituisce le conversazioni persistenti per l'endpoint dell'agente vocale specificato. Le conversazioni sono presenti quando l'impostazione effettiva store della sessione è true, sia che sia ereditata dalla definizione dell'agente sia abilitata dall'override della sessione WebSocket.
listItems	Restituisce una raccolta paginata di elementi — la cronologia completa delle conversazioni ordinata, inclusi input dell'utente, output dell'assistente e output degli strumenti creati dal client (trascrizioni + eventi strumento). Ritorni 404 quando la conversazione non è stata proseguita (store = false).
listResponseItems	Restituisce una raccolta paginata degli elementi in uscita prodotti da una risposta specifica (la proiezione di output della risposta). Per la cronologia completa delle conversazioni ordinate — inclusi input da parte dell'utente e output degli strumenti creati dal client — usa invece la via degli elementi della conversazione. Ritorna 404 quando la conversazione o la risposta non sono state proseguite (store = false).
listResponses	Restituisce una raccolta paginata delle risposte (modellazione di inferenza) registrate per la conversazione specificata. La proiezione per risposta output può essere omessa qui; usa la via dei elementi risposta per l'output canonico paginato. Ritorni 404 quando la conversazione non è stata proseguita (store = false).

Dettagli proprietà

delete

Elimina una conversazione e tutti i suoi dati memorizzati — risposte, elementi e qualsiasi audio (cascata). Questo è il controllo esplicito della cancellazione dei dati per le conversazioni vocali del cliente.

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

Valore della proprietà

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

downloadAudio

Trasmette la registrazione stereo unita dell'intera chiamata come un flusso di byte WAV (audio/wav) attraverso il servizio (senza URL SAS). Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-own-storage (BYOS) i byte non sono proxy — il chiamante deve scaricare direttamente dallo storage del cliente utilizzando la blob_uri via restituita dai metadati — quindi questa route ritorna 409 Conflict per le registrazioni BYOS. Mentre la conversazione è in_progress, questa via restituisce il ritentabile 409 Conflict con error.code = recording_not_ready e un'intestazione Retry-After quando è disponibile una guida per il ritento. Quando la conversazione è failed, restituisce terminale 409 Conflict con error.code = recording_unavailable. Per una completed conversazione, il contenuto è disponibile soggetto al comportamento BYOS esistente. Una conversazione senza audio persistente (store = false) restituisce 404.

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

Valore della proprietà

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

downloadAudioItem

Trasmette in streaming l'audio di un singolo elemento di conversazione come flusso di byte WAV (audio/wav) attraverso il servizio (senza URL SAS). Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-your-own-storage (BYOS) i byte non sono proxy — il chiamante deve scaricare direttamente dallo storage del cliente utilizzando il blob_uri percorso di metadati restituito dall'articolo /audio — quindi questo percorso ritorna 409 Conflict per le registrazioni BYOS. Ritorni 404 quando la conversazione, l'oggetto o il suo audio non sono stati mantenuti (store = false).

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

Valore della proprietà

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

downloadGeneratedAudioItem

Trasmette l'audio generato da un elemento di conversazione come flusso di byte WAV (audio/wav) attraverso il servizio. Questo artefatto subordinato esiste solo quando la riproduzione è stata interrotta e il servizio ha emesso più audio di quanto l'ascoltatore abbia percepito, incluso quando la risposta termina come cancellata. Questa linea serve solo lo stoccaggio gestito dalla fonderia. Per le registrazioni bring-your-own-storage (BYOS) i byte non sono proxy, quindi questa route restituisce 409 Conflict. Ritorna 404 quando la conversazione o l'elemento non sono stati proseguiti, o quando non esiste audio generato oltre il segmento ascoltato.

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

Valore della proprietà

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

get

Recupera una singola conversazione registrata per l'endpoint dell'agente vocale specificato tramite il suo id. Restituisce 404 quando la conversazione non è stata proseguita (store = false) o non esiste.

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

Valore della proprietà

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

getAudio

Restituisce i metadati per la registrazione stereo unita dell'intera chiamata (audio utente sul canale sinistro, audio agente su quello destro). I metadati comuni (formato, frequenza di campionamento, canali, disposizione del canale, durata) vengono restituiti sia per le registrazioni gestite da Foundry sia per quelle BYOS; per BYOS la risposta include blob_uriinoltre , l'URI della registrazione nello storage del cliente (senza SAS) che il cliente scarica con le proprie credenziali. La registrazione viene costruita una volta a partire dai segmenti per turno dopo che la finalizzazione della persistenza è riuscita. Mentre la conversazione è in_progress, questa via restituisce il ritentabile 409 Conflict con error.code = recording_not_ready e un'intestazione Retry-After quando è disponibile una guida per il ritento. Quando la conversazione è failed, restituisce terminale 409 Conflict con error.code = recording_unavailable. Per una completed conversazione, i metadati sono disponibili soggetti al comportamento BYOS esistente. Richiede che la conversazione abbia un audio persistente (store = true); altrimenti restituisce 404.

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

Valore della proprietà

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

getAudioItem

Restituisce i metadati per il segmento audio di un singolo elemento di conversazione, inclusi i fatti comuni di riproduzione (ruolo, formato/codec, frequenza di campionamento, canali, offset, durata) sia per registrazioni gestite da Foundry che per quelle di bring-your-own-storage (BYOS); per BYOS la risposta include blob_uriinoltre , l'URI della registrazione nella memoria del cliente (senza SAS) che il cliente scarica con le proprie credenziali. Richiede che la conversazione abbia un audio persistente (store = true); ritorna 404 quando la conversazione, l'elemento o il suo audio non sono stati persistiti.

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

Valore della proprietà

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

getGeneratedAudioItem

Restituisce i metadati per l'audio generato da un elemento di conversazione. Questo artefatto subordinato è separato dal segmento canonico audio-udito e esiste solo quando la riproduzione è stata interrotta e il servizio ha emesso più audio di quanto l'ascoltatore abbia sentito, incluso quando la risposta termina come cancellata. Ritorna 404 quando la conversazione o l'elemento non sono stati proseguiti, o quando non esiste audio generato oltre il segmento ascoltato.

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

Valore della proprietà

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

getItem

Recupera un singolo elemento dalla conversazione specificata tramite il suo id, inclusa la trascrizione. Una input_audio/output_audio parte di contenuto indica che l'audio è disponibile per l'elemento; i metadati audio canonici per singolo elemento sono la /items/{item_id}/audio risorsa, e i byte sono trasmessi in streaming da ./items/{item_id}/audio/content Ritorni 404 quando la conversazione o l'articolo non sono stati proseguiti (store = false).

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

Valore della proprietà

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

getResponse

Recupera una singola risposta dalla conversazione specificata tramite il suo id, inclusi i suoi output elementi, usage, e stato. Ritorna 404 quando la conversazione o la risposta non sono state proseguite (store = false).

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

Valore della proprietà

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

list

Restituisce le conversazioni persistenti per l'endpoint dell'agente vocale specificato. Le conversazioni sono presenti quando l'impostazione effettiva store della sessione è true, sia che sia ereditata dalla definizione dell'agente sia abilitata dall'override della sessione WebSocket.

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

Valore della proprietà

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

listItems

Restituisce una raccolta paginata di elementi — la cronologia completa delle conversazioni ordinata, inclusi input dell'utente, output dell'assistente e output degli strumenti creati dal client (trascrizioni + eventi strumento). Ritorni 404 quando la conversazione non è stata proseguita (store = false).

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

Valore della proprietà

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

listResponseItems

Restituisce una raccolta paginata degli elementi in uscita prodotti da una risposta specifica (la proiezione di output della risposta). Per la cronologia completa delle conversazioni ordinate — inclusi input da parte dell'utente e output degli strumenti creati dal client — usa invece la via degli elementi della conversazione. Ritorna 404 quando la conversazione o la risposta non sono state proseguite (store = false).

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

Valore della proprietà

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

listResponses

Restituisce una raccolta paginata delle risposte (modellazione di inferenza) registrate per la conversazione specificata. La proiezione per risposta output può essere omessa qui; usa la via dei elementi risposta per l'output canonico paginato. Ritorni 404 quando la conversazione non è stata proseguita (store = false).

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

Valore della proprietà

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