BetaVoiceAgentsConversationsOperations interface

Pakket:

@azure/ai-projects

Operations voor het beheren van spraakagentgesprekken.

Eigenschappen

delete	Verwijdert een gesprek en alle opgeslagen gegevens — reacties, items en alle audio (cascade). Dit is de expliciete data-verwijderingscontrole van de klant voor spraakgesprekken.
downloadAudio	Streamt de samengevoegde stereo-opname van het hele gesprek als een WAV (audio/wav) bytestream door de dienst (geen SAS URL). Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied — de beller moet direct downloaden uit de klantopslag via de blob_uri door de metadata teruggegeven route — dus deze route retourneert 409 Conflict voor BYOS-opnames. Terwijl het gesprek is in_progress, keert deze route terug met 409 Conflicterror.code = recording_not_ready een Retry-After header wanneer er begeleiding beschikbaar is. Wanneer het gesprek is failed, keert het terug naar terminal 409 Conflict met error.code = recording_unavailable. Voor een completed gesprek is inhoud beschikbaar onder voorbehoud van het bestaande BYOS-gedrag. Een gesprek zonder aanhoudende audio (store = false) geeft .404
downloadAudioItem	Streamt de audio van één gespreksitem als een WAV (audio/wav) bytestroom door de service (geen SAS URL). Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied — de beller moet rechtstreeks downloaden van de klantopslag via de blob_uri door het item teruggestuurde /audio metadataroute — dus deze route komt terug 409 Conflict voor BYOS-opnames. Komt terug 404 wanneer het gesprek, het item of de audio ervan niet werd voortgezet (store = false).
downloadGeneratedAudioItem	Streamt de door een conversatieitem gegenereerde audio als een WAV (audio/wav) bytestream door de service. Dit ondergeschikte artefact bestaat alleen wanneer de weergave werd onderbroken en de dienst meer audio leverde dan de luisteraar hoorde, ook wanneer de reactie als geannuleerd eindigt. Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied, dus deze route geeft 409 Conflict. Komt terug 404 wanneer het gesprek of het item niet werd voortgezet, of wanneer er geen gegenereerde audio bestaat buiten het gehoorde segment.
get	Haalt een enkel gesprek op dat is opgenomen voor het opgegeven spraakagent-eindpunt via zijn id. Retourneert 404 wanneer het gesprek niet werd behouden (store = false) of niet bestaat.
getAudio	Geeft metadata terug voor de samengevoegde stereo-opname van het hele gesprek (gebruikersaudio op het linkerkanaal, agentaudio op het rechterkanaal). De gemeenschappelijke metadata (formaat, samplefrequentie, kanalen, kanaalindeling, duur) wordt teruggegeven voor zowel door Foundry beheerde als bring-your-own-storage (BYOS) opnames; voor BYOS bevat blob_uride respons daarnaast ook , de URI van de opname in de eigen opslag van de klant (geen SAS) die de klant downloadt met hun eigen inloggegevens. De opname wordt één keer opgebouwd uit de per-beurt segmenten nadat persistentie-finalisatie is voltooid. Terwijl het gesprek is in_progress, keert deze route terug met 409 Conflicterror.code = recording_not_ready een Retry-After header wanneer er begeleiding beschikbaar is. Wanneer het gesprek is failed, keert het terug naar terminal 409 Conflict met error.code = recording_unavailable. Voor een completed gesprek is metadata beschikbaar, afhankelijk van het bestaande BYOS-gedrag. Vereist dat het gesprek behouden audio bevat (store = true); anders keert het terug 404.
getAudioItem	Geeft metadata terug voor het audiosegment van een enkel gespreksitem, inclusief de gemeenschappelijke weergavefeiten (rol, formaat/codec, samplefrequentie, kanalen, offset, duur) voor zowel Foundry-managed als bring-your-own-storage (BYOS) opnames; voor BYOS bevat blob_uride respons daarnaast ook , de URI van de opname in de eigen opslag van de klant (geen SAS) die de klant downloadt met hun eigen inloggegevens. Vereist dat het gesprek behouden audio bevat (store = true); keert terug 404 wanneer het gesprek, het item of de audio niet werd voortgezet.
getGeneratedAudioItem	Geeft metadata terug voor de door een gespreksitem gegenereerde audio. Dit ondergeschikte artefact staat los van het canonieke gehoorde-audio-segment en bestaat alleen wanneer de weergave werd onderbroken en de dienst meer audio leverde dan de luisteraar hoorde, ook wanneer de reactie als geannuleerd eindigt. Komt terug 404 wanneer het gesprek of het item niet werd voortgezet, of wanneer er geen gegenereerde audio bestaat buiten het gehoorde segment.
getItem	Haalt een enkel item op uit het opgegeven gesprek via zijn id, inclusief het transcript. Een input_audio/output_audio inhoudsdeel geeft aan dat audio beschikbaar is voor het item; de canonieke audiometadata per item is de /items/{item_id}/audio bron, en de bytes worden gestreamd door /items/{item_id}/audio/content. Retourneringen 404 wanneer het gesprek of het item niet werd voortgezet (store = false).
getResponse	Haalt één enkele reactie op uit het opgegeven gesprek via het id, inclusief de output items, usage, en status. Komt terug 404 wanneer het gesprek of antwoord niet is voortgezet (store = false).
list	Geeft de onderhouden gesprekken terug voor het opgegeven voice-agent-eindpunt. Gesprekken zijn aanwezig wanneer de effectieve store instelling van de sessie is true, of deze nu afkomstig is van de agentdefinitie of ingeschakeld door de WebSocket-sessieoverride.
listItems	Geeft een gepagineerde verzameling items terug — de volledige geordende gespreksgeschiedenis, inclusief gebruikersinvoer, assistent-uitvoer en door de client gemaakte tool-uitvoer (transcripties + tool-gebeurtenissen). Komt terug 404 wanneer het gesprek niet werd voortgezet (store = false).
listResponseItems	Geeft een gepagineerde verzameling terug van de outputitems die door een specifieke respons zijn geproduceerd (de outputprojectie van de respons). Voor de volledige geordende gespreksgeschiedenis — inclusief gebruikersinvoer en door de klant gemaakte tool-uitvoer — gebruik in plaats daarvan de route met gespreksitems. Komt terug 404 wanneer het gesprek of antwoord niet is voortgezet (store = false).
listResponses	Geeft een gepagineerde verzameling van de antwoorden (modelinferentiewendingen) terug die zijn opgenomen voor het opgegeven gesprek. De per-responsprojectie output kan hier worden weggelaten; gebruik de respons-items-route voor de canonieke gepagineerde output. Komt terug 404 wanneer het gesprek niet werd voortgezet (store = false).

Eigenschapdetails

delete

Verwijdert een gesprek en alle opgeslagen gegevens — reacties, items en alle audio (cascade). Dit is de expliciete data-verwijderingscontrole van de klant voor spraakgesprekken.

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

Waarde van eigenschap

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

downloadAudio

Streamt de samengevoegde stereo-opname van het hele gesprek als een WAV (audio/wav) bytestream door de dienst (geen SAS URL). Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied — de beller moet direct downloaden uit de klantopslag via de blob_uri door de metadata teruggegeven route — dus deze route retourneert 409 Conflict voor BYOS-opnames. Terwijl het gesprek is in_progress, keert deze route terug met 409 Conflicterror.code = recording_not_ready een Retry-After header wanneer er begeleiding beschikbaar is. Wanneer het gesprek is failed, keert het terug naar terminal 409 Conflict met error.code = recording_unavailable. Voor een completed gesprek is inhoud beschikbaar onder voorbehoud van het bestaande BYOS-gedrag. Een gesprek zonder aanhoudende audio (store = false) geeft .404

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

Waarde van eigenschap

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

downloadAudioItem

Streamt de audio van één gespreksitem als een WAV (audio/wav) bytestroom door de service (geen SAS URL). Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied — de beller moet rechtstreeks downloaden van de klantopslag via de blob_uri door het item teruggestuurde /audio metadataroute — dus deze route komt terug 409 Conflict voor BYOS-opnames. Komt terug 404 wanneer het gesprek, het item of de audio ervan niet werd voortgezet (store = false).

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

Waarde van eigenschap

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

downloadGeneratedAudioItem

Streamt de door een conversatieitem gegenereerde audio als een WAV (audio/wav) bytestream door de service. Dit ondergeschikte artefact bestaat alleen wanneer de weergave werd onderbroken en de dienst meer audio leverde dan de luisteraar hoorde, ook wanneer de reactie als geannuleerd eindigt. Deze route bedient alleen door Foundry beheerde opslag. Voor bring-your-own-storage (BYOS) opnames worden de bytes niet geproxied, dus deze route geeft 409 Conflict. Komt terug 404 wanneer het gesprek of het item niet werd voortgezet, of wanneer er geen gegenereerde audio bestaat buiten het gehoorde segment.

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

Waarde van eigenschap

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

get

Haalt een enkel gesprek op dat is opgenomen voor het opgegeven spraakagent-eindpunt via zijn id. Retourneert 404 wanneer het gesprek niet werd behouden (store = false) of niet bestaat.

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

Waarde van eigenschap

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

getAudio

Geeft metadata terug voor de samengevoegde stereo-opname van het hele gesprek (gebruikersaudio op het linkerkanaal, agentaudio op het rechterkanaal). De gemeenschappelijke metadata (formaat, samplefrequentie, kanalen, kanaalindeling, duur) wordt teruggegeven voor zowel door Foundry beheerde als bring-your-own-storage (BYOS) opnames; voor BYOS bevat blob_uride respons daarnaast ook , de URI van de opname in de eigen opslag van de klant (geen SAS) die de klant downloadt met hun eigen inloggegevens. De opname wordt één keer opgebouwd uit de per-beurt segmenten nadat persistentie-finalisatie is voltooid. Terwijl het gesprek is in_progress, keert deze route terug met 409 Conflicterror.code = recording_not_ready een Retry-After header wanneer er begeleiding beschikbaar is. Wanneer het gesprek is failed, keert het terug naar terminal 409 Conflict met error.code = recording_unavailable. Voor een completed gesprek is metadata beschikbaar, afhankelijk van het bestaande BYOS-gedrag. Vereist dat het gesprek behouden audio bevat (store = true); anders keert het terug 404.

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

Waarde van eigenschap

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

getAudioItem

Geeft metadata terug voor het audiosegment van een enkel gespreksitem, inclusief de gemeenschappelijke weergavefeiten (rol, formaat/codec, samplefrequentie, kanalen, offset, duur) voor zowel Foundry-managed als bring-your-own-storage (BYOS) opnames; voor BYOS bevat blob_uride respons daarnaast ook , de URI van de opname in de eigen opslag van de klant (geen SAS) die de klant downloadt met hun eigen inloggegevens. Vereist dat het gesprek behouden audio bevat (store = true); keert terug 404 wanneer het gesprek, het item of de audio niet werd voortgezet.

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

Waarde van eigenschap

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

getGeneratedAudioItem

Geeft metadata terug voor de door een gespreksitem gegenereerde audio. Dit ondergeschikte artefact staat los van het canonieke gehoorde-audio-segment en bestaat alleen wanneer de weergave werd onderbroken en de dienst meer audio leverde dan de luisteraar hoorde, ook wanneer de reactie als geannuleerd eindigt. Komt terug 404 wanneer het gesprek of het item niet werd voortgezet, of wanneer er geen gegenereerde audio bestaat buiten het gehoorde segment.

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

Waarde van eigenschap

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

getItem

Haalt een enkel item op uit het opgegeven gesprek via zijn id, inclusief het transcript. Een input_audio/output_audio inhoudsdeel geeft aan dat audio beschikbaar is voor het item; de canonieke audiometadata per item is de /items/{item_id}/audio bron, en de bytes worden gestreamd door /items/{item_id}/audio/content. Retourneringen 404 wanneer het gesprek of het item niet werd voortgezet (store = false).

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

Waarde van eigenschap

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

getResponse

Haalt één enkele reactie op uit het opgegeven gesprek via het id, inclusief de output items, usage, en status. Komt terug 404 wanneer het gesprek of antwoord niet is voortgezet (store = false).

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

Waarde van eigenschap

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

list

Geeft de onderhouden gesprekken terug voor het opgegeven voice-agent-eindpunt. Gesprekken zijn aanwezig wanneer de effectieve store instelling van de sessie is true, of deze nu afkomstig is van de agentdefinitie of ingeschakeld door de WebSocket-sessieoverride.

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

Waarde van eigenschap

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

listItems

Geeft een gepagineerde verzameling items terug — de volledige geordende gespreksgeschiedenis, inclusief gebruikersinvoer, assistent-uitvoer en door de client gemaakte tool-uitvoer (transcripties + tool-gebeurtenissen). Komt terug 404 wanneer het gesprek niet werd voortgezet (store = false).

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

Waarde van eigenschap

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

listResponseItems

Geeft een gepagineerde verzameling terug van de outputitems die door een specifieke respons zijn geproduceerd (de outputprojectie van de respons). Voor de volledige geordende gespreksgeschiedenis — inclusief gebruikersinvoer en door de klant gemaakte tool-uitvoer — gebruik in plaats daarvan de route met gespreksitems. Komt terug 404 wanneer het gesprek of antwoord niet is voortgezet (store = false).

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

Waarde van eigenschap

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

listResponses

Geeft een gepagineerde verzameling van de antwoorden (modelinferentiewendingen) terug die zijn opgenomen voor het opgegeven gesprek. De per-responsprojectie output kan hier worden weggelaten; gebruik de respons-items-route voor de canonieke gepagineerde output. Komt terug 404 wanneer het gesprek niet werd voortgezet (store = false).

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

Waarde van eigenschap

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