BetaVoiceAgentsConversationsOperations interface

パッケージ:

@azure/ai-projects

音声エージェントとの会話を管理するためのオペレーション。

プロパティ

delete	会話とその保存されたすべてのデータ—応答、アイテム、そしてすべての音声(カスケード)—を削除します。 これは音声会話に対する顧客の明示的なデータ削除制御です。
downloadAudio	サービスを通じてWAV(audio/wav)バイトストリームとして、通話全体を統合したステレオ録音をストリーミングします(SASのURLはありません)。 このルートはFoundry管理の保管施設のみに対応しています。 持ち込みストレージ(BYOS)録音の場合、バイトはプロキシされません。発信者はメタデータルートで返された blob_uri を使って顧客ストレージから直接ダウンロードしなければなりません。したがって、このルートはBYOS録音に対して 409 Conflict を返します。 会話がin_progressされている間、このルートはリトライガイダンスが利用可能であれば、error.code = recording_not_readyとRetry-Afterヘッダー付きのリトロール可能な409 Conflictを返します。 会話が終 failedされると、端末の終 409 Conflict で返 error.code = recording_unavailableします。 completed会話の場合、既存のBYOSの行動に応じてコンテンツが利用可能です。 持続音声(store = false)がない会話は 404戻ります。
downloadAudioItem	単一の会話項目の音声をWAV(audio/wav)バイトストリームとしてサービスを通じてストリーミングします(SASのURLはありません)。 このルートはFoundry管理の保管施設のみに対応しています。 持ち込みストレージ(BYOS)録音の場合、バイトはプロキシされません。発信者は顧客ストレージから/audioメタデータルートで返されるblob_uriを使って直接ダウンロードしなければなりません。このルートはBYOS録音に対して409 Conflict返します。 会話、アイテム、音声が永続化されなかった場合(store = false)に返404。
downloadGeneratedAudioItem	会話項目の生成音声をWAV(audio/wav)バイトストリームとしてサービスを通じてストリーミングします。 この従属的なアーティファクトは、再生が中断され、サービスがリスナーに聞こえる以上の音声を提供した場合にのみ存在し、応答がキャンセルされた状態で終了した場合も含まれます。 このルートはFoundry管理の保管施設のみに対応しています。 持ち込みストレージ(BYOS)録画の場合、バイトはプロキシされないため、このルートは返 409 Conflictします。 会話や項目が永続化されなかった場合、または聞いた部分以外に生成された音声が存在しない場合に返 404 。
get	指定されたボイスエージェントエンドポイントのIDで録音された単一の会話を取得。会話が永続化されていない(store = false)または存在しない404返します。
getAudio	通話全体で統合されたステレオ録音のメタデータ(ユーザー音声は左チャンネル、エージェント音声は右チャンネル)を返します。 共通のメタデータ(フォーマット、サンプルレート、チャネル、チャンネルレイアウト、持続時間)は、Foundry管理の録画と持ち込みストレージ(BYOS)の両方で返されます。BYOSの場合、応答には顧客自身のストレージ(SASなし)内の録画のURI( blob_uri)が含まれ、顧客は自身の認証情報でダウンロードします。 永続性の最終化が成功した後、各ターンのセグメントから記録は1回ずつ構築されます。 会話がin_progressされている間、このルートはリトライガイダンスが利用可能であれば、error.code = recording_not_readyとRetry-Afterヘッダー付きのリトロール可能な409 Conflictを返します。 会話が終 failedされると、端末の終 409 Conflict で返 error.code = recording_unavailableします。 completed会話のために、メタデータは既存のBYOSの動作に応じて利用可能です。 会話に永続音声(store = true)が必要;そうでなければ返 404。
getAudioItem	単一の会話項目の音声セグメントのメタデータを返します。Foundry管理録音および自用ストレージ(BYOS)録音の両方で、共通の再生事実(役割、フォーマット/コーデック、サンプルレート、チャンネル、オフセット、持続時間)が含まれます。BYOSの場合、回答には顧客自身のストレージ(SASなし)にある録音のURI( blob_uri)も含まれており、顧客は自身の認証情報でダウンロードします。 会話に永続音声(store = true)が必要で、会話、アイテム、または音声が永続化されなかった場合に 404 戻ります。
getGeneratedAudioItem	会話項目の生成音声のメタデータを返します。 この従属的なアーティファクトは、正準音声セグメントとは別で、再生が中断され、サービスがリスナーが聞いた以上の音声を提供した場合にのみ存在し、応答がキャンセルされたまま終了した場合も含まれます。 会話や項目が永続化されなかった場合、または聞いた部分以外に生成された音声が存在しない場合に返 404 。
getItem	指定された会話からidで単一の項目を取得し、その書き起こしも含まれます。 コンテンツ input_audio/output_audio 部分は、そのアイテムに対して音声が利用可能であることを示します。標準的なアイテムごとの音声メタデータが /items/{item_id}/audio リソースであり、バイトは /items/{item_id}/audio/contentでストリーミングされます。 会話やアイテムが永続化されなかった場合(store = false)に返404。
getResponse	指定された会話からidで単一の応答を取り出し、 output 項目、 usage、ステータスを含みます。 会話や返答が継続されなかった場合(store = false)に返404。
list	指定されたボイスエージェントエンドポイントで永続された会話を返します。 セッションの実効 store 設定が trueされている場合、エージェント定義から継承されたものであれ、WebSocketのセッションオーバーライドによって有効化された場合でも、会話は存在します。
listItems	ページごとにまとめられたアイテムのコレクションを返します。これは、ユーザー入力、アシスタント出力、クライアント作成ツール出力(トランスクリプト+ツールイベント)を含む、順序付けられた会話履歴の完全な順序付きです。 会話が継続されなかった場合(store = false)404返送。
listResponseItems	特定の応答によって生成された出力項目のページ集合(応答の出力投影)を返します。 ユーザー入力やクライアント作成ツールの出力を含む完全な順序付き会話履歴を知りたい場合は、代わりに会話項目ルートをご利用ください。 会話や返答が継続されなかった場合(store = false)に返404。
listResponses	指定された会話で記録された応答(モデル推論ターン)のページ集合を返します。 ここでは応答ごとの output 予測を省略しても構いません。正準ページ出力には応答項目ルートを用いてください。 会話が継続されなかった場合(store = false)404返送。

プロパティの詳細

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されている間、このルートはリトライガイダンスが利用可能であれば、error.code = recording_not_readyとRetry-Afterヘッダー付きのリトロール可能な409 Conflictを返します。 会話が終 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)録音の場合、バイトはプロキシされません。発信者は顧客ストレージから/audioメタデータルートで返されるblob_uriを使って直接ダウンロードしなければなりません。このルートはBYOS録音に対して409 Conflict返します。 会話、アイテム、音声が永続化されなかった場合(store = false)に返404。

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の場合、応答には顧客自身のストレージ(SASなし)内の録画のURI( blob_uri)が含まれ、顧客は自身の認証情報でダウンロードします。 永続性の最終化が成功した後、各ターンのセグメントから記録は1回ずつ構築されます。 会話がin_progressされている間、このルートはリトライガイダンスが利用可能であれば、error.code = recording_not_readyとRetry-Afterヘッダー付きのリトロール可能な409 Conflictを返します。 会話が終 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の場合、回答には顧客自身のストレージ(SASなし)にある録音のURI( blob_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でストリーミングされます。 会話やアイテムが永続化されなかった場合(store = false)に返404。

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、ステータスを含みます。 会話や返答が継続されなかった場合(store = false)に返404。

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

ページごとにまとめられたアイテムのコレクションを返します。これは、ユーザー入力、アシスタント出力、クライアント作成ツール出力(トランスクリプト+ツールイベント)を含む、順序付けられた会話履歴の完全な順序付きです。 会話が継続されなかった場合(store = false)404返送。

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

プロパティ値

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

listResponseItems

特定の応答によって生成された出力項目のページ集合(応答の出力投影)を返します。 ユーザー入力やクライアント作成ツールの出力を含む完全な順序付き会話履歴を知りたい場合は、代わりに会話項目ルートをご利用ください。 会話や返答が継続されなかった場合(store = false)に返404。

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 予測を省略しても構いません。正準ページ出力には応答項目ルートを用いてください。 会話が継続されなかった場合(store = false)404返送。

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

プロパティ値

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