BetaVoiceAgentsConversationsOperations interface
用于管理语音代理对话的运营。
属性
| delete | 删除对话及其所有存储的数据——回复、项目和任何音频(级联)。 这是客户对语音对话的显式数据删除控制。 |
| download |
通过服务以WAV( |
| download |
通过服务以WAV ( |
| download |
通过服务将对话项目生成的音频以 WAV ( |
| get | 通过指定语音代理端点的id检索一段对话。当对话未被持久化( |
| get |
返回整通话合并立体声录音的元数据(用户音频在左声道,代理音频在右声道)。 Foundry管理和自带存储(BYOS)录制时,返回通用元数据(格式、采样率、通道、通道布局、时长);对于BYOS的响应还包括 |
| get |
返回单个对话项目音频段的元数据,包括Foundry管理和自带存储(BYOS)录音的常见回放事实(角色、格式/编解码器、采样率、通道、偏移量、时长);对于BYOS,响应还包括 |
| get |
返回对话项目生成音频的元数据。 该次级伪影与正规听音频段分开,仅在播放中断且服务提供超过听者听到的音频时存在,包括响应结束时被取消。 当对话或项目未被持续保存,或在听到的片段之外没有生成音频时返回 |
| get |
通过ID从指定对话中获取单个项目,包括其文字记录。 内容 |
| get |
通过id(包括 |
| list | 返回指定的语音代理端点所保留的对话。
当会话的有效 |
| list |
返回一个分页的项目集合——完整的有序对话历史,包括用户输入、助理输出和客户创建的工具输出(文字记录 + 工具事件)。 当对话未被持续保存时返回 |
| list |
返回由特定反应产生的输出项目分页集合(该响应的输出投影)。 对于完整的有序对话历史——包括用户输入和客户端创建的工具输出——请使用对话项目路线。 当对话或回复未被持续时返回 |
| list |
返回指定对话中记录的分页回应(模型推理回合)。 此处可省略每个响应 |
属性详细信息
delete
删除对话及其所有存储的数据——回复、项目和任何音频(级联)。 这是客户对语音对话的显式数据删除控制。
delete: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDeleteOptionalParams) => Promise<void>
downloadAudio
通过服务以WAV(audio/wav)字节流形式流式传输整通话合并立体声录音(不含SAS URL)。 该线路仅服务于Foundry管理的存储。 对于自带存储(BYOS)录音,这些字节不被代理——呼叫者必须通过 blob_uri 元数据返回路径直接从客户存储下载——因此该路由 409 Conflict 返回BYOS录音。
当对话为 in_progress时,该路由返回可重试 409 Conflict 和 error.code = recording_not_readyRetry-After 头部,当有重试引导时。 当对话为 failed时,返回 409 Conflict 终端 ,且 error.code = recording_unavailable。
对于对话 completed ,内容可根据现有的自带用户行为(BYOS)进行访问。 没有持续音频(store = false)的对话返回 404。
downloadAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsDownloadAudioOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioResponse>
downloadAudioItem
通过服务以WAV (audio/wav) 字节流形式流式传输单一对话项目的音频流(无SAS URL)。 该线路仅服务于Foundry管理的存储。 对于自带存储(BYOS)录音,这些字节不被代理——呼叫者必须直接从客户存储下载,使用 blob_uri 该项目 /audio 元数据返回的路径——因此BYOS录音会返回 409 Conflict 该路由。
当对话、物品或音频未被持久化时返回 404 (store = false)。
downloadAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>
属性值
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadAudioItemResponse>
downloadGeneratedAudioItem
通过服务将对话项目生成的音频以 WAV (audio/wav) 字节流形式流式传输。 该次级伪影仅在播放中断且服务提供的音频超过听众听到的音频时存在,包括响应以取消结束时。 该线路仅服务于Foundry管理的存储。
对于自带存储(BYOS)录音,这些字节不被代理,因此该路径返回 409 Conflict。
当对话或项目未被持续保存,或在听到的片段之外没有生成音频时返回 404 。
downloadGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>
属性值
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams) => Promise<BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse>
get
通过指定语音代理端点的id检索一段对话。当对话未被持久化(store = false)或不存在时返回404。
get: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetOptionalParams) => Promise<VoiceConversation>
getAudio
返回整通话合并立体声录音的元数据(用户音频在左声道,代理音频在右声道)。 Foundry管理和自带存储(BYOS)录制时,返回通用元数据(格式、采样率、通道、通道布局、时长);对于BYOS的响应还包括 blob_uri客户自有存储(无SAS)中录制的URI,客户用自己的凭证下载。 在持久性最终确定后,记录从每回合段建立一次。 当对话为 in_progress时,该路由返回可重试 409 Conflict 和 error.code = recording_not_readyRetry-After 头部,当有重试引导时。 当对话为 failed时,返回 409 Conflict 终端 ,且 error.code = recording_unavailable。
对于 completed 对话,元数据可根据现有的BYOS行为获得。 要求对话具有持久音频(store = true;)否则返回 404。
getAudio: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsGetAudioOptionalParams) => Promise<VoiceRecording>
getAudioItem
返回单个对话项目音频段的元数据,包括Foundry管理和自带存储(BYOS)录音的常见回放事实(角色、格式/编解码器、采样率、通道、偏移量、时长);对于BYOS,响应还包括 blob_uri客户自有存储(无SAS)中录音的URI,客户用自己的凭证下载。
要求对话中存在持久音频(store = true;)当对话、物品或音频未被持久化时返回 404 。
getAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>
属性值
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetAudioItemOptionalParams) => Promise<VoiceAudioItem>
getGeneratedAudioItem
返回对话项目生成音频的元数据。 该次级伪影与正规听音频段分开,仅在播放中断且服务提供超过听者听到的音频时存在,包括响应结束时被取消。 当对话或项目未被持续保存,或在听到的片段之外没有生成音频时返回 404 。
getGeneratedAudioItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>
属性值
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams) => Promise<VoiceGeneratedAudioItem>
getItem
通过ID从指定对话中获取单个项目,包括其文字记录。 内容 input_audio/output_audio 部分表示该项目的音频可用;每个项目的规范音频元数据是 /items/{item_id}/audio 资源,字节由 流式 /items/{item_id}/audio/content传输。 当对话或项目未被持久化时返回 404 (store = false)。
getItem: (agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>
属性值
(agentName: string, conversationId: string, itemId: string, options?: BetaVoiceAgentsConversationsGetItemOptionalParams) => Promise<RealtimeConversationItemUnion>
getResponse
通过id(包括 output 项目) usage和状态从指定对话中获取单个响应。 当对话或回复未被持续时返回 404 (store = false)。
getResponse: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>
属性值
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsGetResponseOptionalParams) => Promise<VoiceResponse>
list
返回指定的语音代理端点所保留的对话。
当会话的有效 store 设置为 true时,无论是继承自代理定义还是由 WebSocket 会话覆盖启用,会话都存在。
list: (agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>
属性值
(agentName: string, options?: BetaVoiceAgentsConversationsListOptionalParams) => PagedAsyncIterableIterator<VoiceConversation, VoiceConversation[], PageSettings>
listItems
返回一个分页的项目集合——完整的有序对话历史,包括用户输入、助理输出和客户创建的工具输出(文字记录 + 工具事件)。 当对话未被持续保存时返回 404 (store = false)。
listItems: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponseItems
返回由特定反应产生的输出项目分页集合(该响应的输出投影)。 对于完整的有序对话历史——包括用户输入和客户端创建的工具输出——请使用对话项目路线。 当对话或回复未被持续时返回 404 (store = false)。
listResponseItems: (agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
属性值
(agentName: string, conversationId: string, responseId: string, options?: BetaVoiceAgentsConversationsListResponseItemsOptionalParams) => PagedAsyncIterableIterator<RealtimeConversationItemUnion, RealtimeConversationItemUnion[], PageSettings>
listResponses
返回指定对话中记录的分页回应(模型推理回合)。 此处可省略每个响应 output 的预测;对于规范分页输出,请使用响应项路径。 当对话未被持续保存时返回 404 (store = false)。
listResponses: (agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>
属性值
(agentName: string, conversationId: string, options?: BetaVoiceAgentsConversationsListResponsesOptionalParams) => PagedAsyncIterableIterator<VoiceResponse, VoiceResponse[], PageSettings>