BetaVoiceAgentsConversationsOperations interface

套件:

@azure/ai-projects

負責管理語音代理對話的營運。

屬性

delete	刪除對話及其所有儲存的資料——回應、項目和任何音訊（連鎖反應）。 這是客戶對語音通話的明確資料刪除控制。
downloadAudio	透過服務串流整通合併的立體聲錄音，以 WAV （audio/wav） 位元組串流（無 SAS URL）。 此路線僅服務 Foundry 管理的倉儲。 對於自帶儲存（BYOS）錄音，位元組不會被代理——呼叫者必須直接從客戶儲存下載，使用 blob_uri 元資料回傳路徑——因此 BYOS 錄音會回傳 409 Conflict 此路由。 當對話為 in_progress時，當有重試指引時，此路由會回傳可重試 409 Conflict 且 error.code = recording_not_ready 標 Retry-After 頭為 。 當對話為 failed時，返回409 Conflict終端 。error.code = recording_unavailable 對話 completed 內容可依現有 BYOS 行為提供。 沒有持續音訊（store = false）的對話會返回 404。
downloadAudioItem	透過服務串流單一對話項目的音訊，作為 WAV （audio/wav） 位元組串流（無 SAS URL）。 此路線僅服務 Foundry 管理的倉儲。 對於自帶儲存（BYOS）錄音，位元組不會被代理——呼叫者必須直接從客戶儲存下載，使用 blob_uri 該項目 /audio 回傳的元資料路徑——因此此路由會回傳 409 Conflict BYOS 錄音。 當對話、物品或音訊未被持續保存時，返回 404 （store = false）。
downloadGeneratedAudioItem	透過服務串流對話項目產生的音訊，作為 WAV （audio/wav） 位元組串流。 這個次要偽影僅在播放中斷且服務提供超過聽者所聽到的音訊時存在，包括回應以取消結束時。 此路線僅服務 Foundry 管理的倉儲。 對於自帶儲存（BYOS）錄音，位元組不會被代理，因此此路徑會回傳 409 Conflict。 當對話或項目未被持續保存，或在聽到的段落之外沒有產生音訊時，會回傳 404 。
get	透過 id 擷取指定語音代理端點的單一對話。當對話未被持久化（store = false）或不存在時，會回傳404。
getAudio	回傳整通話合併立體聲錄音的元資料（左聲道為使用者音訊，右聲道為代理音訊）。 Foundry 管理及自帶儲存（BYOS）錄影都會回傳常見的元資料（格式、取樣率、通道、通道配置、時長）;對於 BYOS，回應還包括 blob_uri客戶自有儲存（無 SAS）中錄製的 URI，客戶以自己的憑證下載。 當持久性最終確定後，記錄會從每回合的區段建立一次。 當對話為 in_progress時，當有重試指引時，此路由會回傳可重試 409 Conflict 且 error.code = recording_not_ready 標 Retry-After 頭為 。 當對話為 failed時，返回409 Conflict終端 。error.code = recording_unavailable 對於 completed 對話而言，元資料會依據現有的 BYOS 行為提供。 需要對話持續音訊store = true（）;否則返回 404。
getAudioItem	回傳單一對話項目音訊片段的元資料，包括 Foundry 管理及自帶儲存（BYOS）錄音的常見播放事實（角色、格式/編碼、取樣率、通道、偏移量、時長）;對於 BYOS 回應，還包括 blob_uri客戶自有儲存（非 SAS）中錄音的 URI，客戶以自己的憑證下載。 要求對話必須有持久音訊（store = true;;當對話、物品或音訊未被持續保存時，會回傳 404 。
getGeneratedAudioItem	回傳對話項目產生音訊的元資料。 此次級雜訊與標準可聽音訊段分開，僅在播放中斷且服務提供超過聽者所聽到的音訊時存在，包括回應結束為取消時。 當對話或項目未被持續保存，或在聽到的段落之外沒有產生音訊時，會回傳 404 。
getItem	透過 id 從指定對話中擷取單一項目，包括逐字稿。 內容input_audio/output_audio部分表示該項目有音訊可用;標準的每個項目音訊中繼資料是/items/{item_id}/audio資源，位元組由 串流。/items/{item_id}/audio/content 當對話或項目未被持續保存時，會回傳 404 （store = false）。
getResponse	透過 id 從指定對話中擷取單一回應，包括項目 output 、 usage、狀態。 當對話或回應未被持續執行時，會回傳 404 （store = false）。
list	回傳的是針對指定的語音代理端點持續存在的對話。 當會話的有效 store 設定為 時 true，對話即存在，無論是繼承自代理定義或由 WebSocket 會話覆寫所啟用。
listItems	回傳一組分頁的項目集合——完整的有序對話歷史，包括使用者輸入、助理輸出及客戶建立的工具輸出（逐字稿 + 工具事件）。 當對話未持續執行時會回傳 404 （store = false）。
listResponseItems	回傳由特定回應產生的輸出項目分頁集合（回應的輸出投影）。 若要完整排序對話歷史——包括使用者輸入與客戶自製工具輸出——則改用對話項目路徑。 當對話或回應未被持續執行時，會回傳 404 （store = false）。
listResponses	回傳指定對話中記錄的回應（模型推論回合）分頁集合。 此處可省略每個回應 output 的預測;對於標準分頁輸出，請使用回應項目路徑。 當對話未持續執行時會回傳 404 （store = false）。

屬性詳細資料

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 元資料回傳路徑——因此 BYOS 錄音會回傳 409 Conflict 此路由。 當對話為 in_progress時，當有重試指引時，此路由會回傳可重試 409 Conflict 且 error.code = recording_not_ready 標 Retry-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 回傳的元資料路徑——因此此路由會回傳 409 Conflict BYOS 錄音。 當對話、物品或音訊未被持續保存時，返回 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_ready 標 Retry-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>