BetaVoiceAgentsConversationsOperations interface
Drift för hantering av röstsamtal mellan agenter.
Egenskaper
| delete | Raderar en konversation och all dess lagrade data — svar, objekt och all ljud (kaskad). Detta är kundens explicita kontroll för dataradering av röstsamtal. |
| download |
Strömmar hela samtalets sammanslagna stereoinspelning som en WAV ( |
| download |
Strömmar ljudet från en enskild konversationspunkt som en WAV ( |
| download |
Strömmar ett konversationsobjekts genererade ljud som en WAV ( |
| get | Hämtar en enskild konversation inspelad för den angivna röstagentens endpoint via dess id. Returnerar |
| get |
Returnerar metadata för hela samtalets sammanslagna stereoinspelning (användarljud på vänster kanal, agentljud på höger). Den gemensamma metadatan (format, samplingsfrekvens, kanaler, kanallayout, varaktighet) returneras för både Foundry-managed och bring-your-own-storage (BYOS)-inspelningar; för BYOS inkluderar |
| get |
Returnerar metadata för ett enskilt konversationsobjekts ljudsegment, inklusive vanliga uppspelningsfakta (roll, format/codec, samplingsfrekvens, kanaler, offset, varaktighet) för både Foundry-managed och bring-your-own-storage (BYOS)-inspelningar; för BYOS inkluderar |
| get |
Returnerar metadata för ett konversationsobjekts genererade ljud. Denna underordnade artefakt är separat från det kanoniska hörda-ljudsegmentet och existerar endast när uppspelningen avbrutits och tjänsten gav mer ljud än lyssnaren hörde, inklusive när svaret avslutas som avbrutet. Återvänder |
| get |
Hämtar en enskild post från den angivna konversationen via dess id, inklusive dess transkription. En |
| get |
Hämtar ett enda svar från den specificerade konversationen via dess id, inklusive dess |
| list | Returnerar konversationerna som upprätthållits för den angivna röstagentens endpoint.
Konversationer finns när sessionens effektiva |
| list |
Returnerar en sidad samling av objekt — den kompletta ordnade konversationshistoriken, inklusive användarinmatning, assistentutdata och klientskapade verktygsutdata (transkriptioner + verktygshändelser). Återkommer |
| list |
Returnerar en sidad samling av de utdata som producerats av ett specifikt svar (svarets utdata projektion). För den fullständiga ordnade konversationshistoriken – inklusive användarinmatning och klientskapade verktygsutdata – använd istället konversationsrutten. Återkommer |
| list |
Returnerar en sidad samling av svaren (modellinferensvändningar) som spelats in för den angivna konversationen. Projen per respons |
Egenskapsinformation
delete
Raderar en konversation och all dess lagrade data — svar, objekt och all ljud (kaskad). Detta är kundens explicita kontroll för dataradering av röstsamtal.
delete: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>
downloadAudio
Strömmar hela samtalets sammanslagna stereoinspelning som en WAV (audio/wav) byteström genom tjänsten (ingen SAS-URL). Denna rutt betjänar endast lagring som hanteras av Foundry. För bring-your-own-storage (BYOS)-inspelningar är bytena inte proxiade — uppringaren måste ladda ner direkt från kundlagring via den blob_uri route som returneras av metadata — så denna rutt returnerar 409 Conflict för BYOS-inspelningar.
Medan samtalet är in_progress, återvänder denna rutt med 409 Conflicterror.code = recording_not_ready och en Retry-After rubrik när återförsöksvägledning finns tillgänglig. När konversationen är failed, returnerar den terminal 409 Conflict med error.code = recording_unavailable.
För en completed konversation finns innehållet tillgängligt under förutsättning att det befintliga BYOS-beteendet är tillåtet. En konversation utan bestående ljud (store = false) returnerar 404.
downloadAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>
downloadAudioItem
Strömmar ljudet från en enskild konversationspunkt som en WAV (audio/wav) byteström genom tjänsten (ingen SAS-URL). Denna rutt betjänar endast lagring som hanteras av Foundry. För bring-your-own-storage (BYOS)-inspelningar är bytena inte proxiade — uppringaren måste ladda ner direkt från kundlagring via den blob_uri metadata-rutt som returneras av objektet /audio — så denna rutt returnerar 409 Conflict för BYOS-inspelningar.
Återkommer 404 när konversationen, objektet eller dess ljud inte har bevarats (store = false).
downloadAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>
Egenskapsvärde
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>
downloadGeneratedAudioItem
Strömmar ett konversationsobjekts genererade ljud som en WAV (audio/wav) byteström genom tjänsten. Denna underordnade artefakt existerar endast när uppspelningen avbrutits och tjänsten gav mer ljud än vad lyssnaren hörde, inklusive när svaret avslutas som avbrutet. Denna rutt betjänar endast lagring som hanteras av Foundry.
För bring-your-own-storage (BYOS)-inspelningar är bytena inte proxiade, så denna rutt returnerar 409 Conflict.
Återvänder 404 när samtalet eller objektet inte fortsatte, eller när inget genererat ljud finns bortom det hörda segmentet.
downloadGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>
Egenskapsvärde
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>
get
Hämtar en enskild konversation inspelad för den angivna röstagentens endpoint via dess id. Returnerar 404 när konversationen inte har bevarats (store = false) eller inte existerar.
get: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>
getAudio
Returnerar metadata för hela samtalets sammanslagna stereoinspelning (användarljud på vänster kanal, agentljud på höger). Den gemensamma metadatan (format, samplingsfrekvens, kanaler, kanallayout, varaktighet) returneras för både Foundry-managed och bring-your-own-storage (BYOS)-inspelningar; för BYOS inkluderar blob_urisvaret dessutom , URI:n för inspelningen i kundens egen lagring (ingen SAS) som kunden laddar ner med sina egna inloggningsuppgifter. Inspelningen byggs upp en gång från segmenten per tur efter att persistensfinaliseringen har lyckats. Medan samtalet är in_progress, återvänder denna rutt med 409 Conflicterror.code = recording_not_ready och en Retry-After rubrik när återförsöksvägledning finns tillgänglig. När konversationen är failed, returnerar den terminal 409 Conflict med error.code = recording_unavailable.
För en completed konversation finns metadata tillgänglig under förutsättning att det befintliga BYOS-beteendet fungerar. Kräver att konversationen har bestående ljud (store = true); annars returnerar 404den .
getAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>
getAudioItem
Returnerar metadata för ett enskilt konversationsobjekts ljudsegment, inklusive vanliga uppspelningsfakta (roll, format/codec, samplingsfrekvens, kanaler, offset, varaktighet) för både Foundry-managed och bring-your-own-storage (BYOS)-inspelningar; för BYOS inkluderar blob_urisvaret dessutom , URI:n för inspelningen i kundens egen lagring (ingen SAS) som kunden laddar ner med sina egna inloggningsuppgifter.
Kräver att konversationen har kvarvarande ljud (store = true); återkommer 404 när konversationen, objektet eller dess ljud inte har bevarats.
getAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>
Egenskapsvärde
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>
getGeneratedAudioItem
Returnerar metadata för ett konversationsobjekts genererade ljud. Denna underordnade artefakt är separat från det kanoniska hörda-ljudsegmentet och existerar endast när uppspelningen avbrutits och tjänsten gav mer ljud än lyssnaren hörde, inklusive när svaret avslutas som avbrutet. Återvänder 404 när samtalet eller objektet inte fortsatte, eller när inget genererat ljud finns bortom det hörda segmentet.
getGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>
Egenskapsvärde
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>
getItem
Hämtar en enskild post från den angivna konversationen via dess id, inklusive dess transkription. En input_audio/output_audio innehållsdel indikerar att ljud är tillgängligt för objektet; den kanoniska ljudmetadata per objekt är resursen/items/{item_id}/audio, och bytena strömmas av ./items/{item_id}/audio/content Returnerar 404 när konversationen eller varan inte fortsatte (store = false).
getItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>
Egenskapsvärde
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>
getResponse
Hämtar ett enda svar från den specificerade konversationen via dess id, inklusive dess output objekt, usage, och status. Återkommer 404 när samtalet eller svaret inte fortsatte (store = false).
getResponse: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>
Egenskapsvärde
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>
list
Returnerar konversationerna som upprätthållits för den angivna röstagentens endpoint.
Konversationer finns när sessionens effektiva store inställning är true, antingen ärvd från agentdefinitionen eller möjliggjord av WebSocket-sessionens överskrivning.
list: (agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>
Egenskapsvärde
(agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>
listItems
Returnerar en sidad samling av objekt — den kompletta ordnade konversationshistoriken, inklusive användarinmatning, assistentutdata och klientskapade verktygsutdata (transkriptioner + verktygshändelser). Återkommer 404 när samtalet inte fortsatte (store = false).
listItems: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponseItems
Returnerar en sidad samling av de utdata som producerats av ett specifikt svar (svarets utdata projektion). För den fullständiga ordnade konversationshistoriken – inklusive användarinmatning och klientskapade verktygsutdata – använd istället konversationsrutten. Återkommer 404 när samtalet eller svaret inte fortsatte (store = false).
listResponseItems: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
Egenskapsvärde
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponses
Returnerar en sidad samling av svaren (modellinferensvändningar) som spelats in för den angivna konversationen. Projen per respons output kan utelämnas här; använd svarsrutten för den kanoniska sidutdatan. Återkommer 404 när samtalet inte fortsatte (store = false).
listResponses: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>
Egenskapsvärde
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>