VoiceAgentRealtimeResponse interface

パッケージ:

@azure/ai-projects

音声エージェントサービスによるライブリアルタイム応答は、 response.created およびイベントの両方で response.done 回されます。

Extends

VoiceAgentRealtimeResponseBase

プロパティ

audio	ライブレスポンスで使用される音声構成(フラットボイスプロバイダー、ロケーション、フォーマットフィールドを含む output)。
output	ライブレスポンスによって生成されるアイテム。

継承されたプロパティ

conversation_id	どの会話に追加されるかは、conversationイベントのresponse.createフィールドによって決まります。 autoなら、応答はデフォルトの会話に追加され、conversation_idの値はidとして付与されますconv_1234。 noneた場合、その回答は会話に追加されず、conversation_idの価値は損nullします。 VADによって自動的に応答がトリガーされている場合、その応答はデフォルトの会話に追加されます
id	応答の一意IDは resp_1234のようになります。
max_output_tokens	この応答で使用されたツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。
metadata	応答に関連付けられたカスタム文字列のキー-値ペア。
object	オブジェクトタイプは realtime.responseでなければなりません。
output_modalities	モデルが応答するために用いたモダリティの集合、現在可能な値は [\"audio\"]、 [\"text\"]のみです。 音声出力には必ずテキストの書き起こしが含まれています。 出力をモード text に設定すると、モデルからの音声出力が無効になります。
status	応答の最終状態(completed、 cancelled、 failed、または incomplete、 in_progress)。
status_details	状況に関する追加情報。
usage	応答の利用統計は請求に対応します。 リアルタイムAPIセッションは会話コンテキストを維持し、新しいアイテムを会話に追加するため、前のターンからの出力(テキストおよび音声トークン)が後のターンの入力となります。

プロパティの詳細

audio

ライブレスポンスで使用される音声構成(フラットボイスプロバイダー、ロケーション、フォーマットフィールドを含む output)。

audio?: VoiceResponseAudio

プロパティ値

VoiceResponseAudio

output

ライブレスポンスによって生成されるアイテム。

output?: RealtimeConversationItemUnion[]

プロパティ値

RealtimeConversationItemUnion[]

継承されたプロパティの詳細

conversation_id

どの会話に追加されるかは、conversationイベントのresponse.createフィールドによって決まります。 autoなら、応答はデフォルトの会話に追加され、conversation_idの値はidとして付与されますconv_1234。 noneた場合、その回答は会話に追加されず、conversation_idの価値は損nullします。 VADによって自動的に応答がトリガーされている場合、その応答はデフォルトの会話に追加されます

conversation_id?: string

プロパティ値

string

VoiceAgentRealtimeResponseBase.conversation_idから受け継いだ

id

応答の一意IDは resp_1234のようになります。

id?: string

プロパティ値

string

継承 VoiceAgentRealtimeResponseBase.id

max_output_tokens

この応答で使用されたツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。

max_output_tokens?: number | "inf"

プロパティ値

number | "inf"

VoiceAgentRealtimeResponseBase.max_output_tokensから継承

metadata

応答に関連付けられたカスタム文字列のキー-値ペア。

metadata?: Metadata

プロパティ値

Metadata

VoiceAgentRealtimeResponseBase.メタデータから継承

object

オブジェクトタイプは realtime.responseでなければなりません。

object?: "realtime.response"

プロパティ値

"realtime.response"

VoiceAgentRealtimeResponseBase.objectから継承

output_modalities

モデルが応答するために用いたモダリティの集合、現在可能な値は [\"audio\"]、 [\"text\"]のみです。 音声出力には必ずテキストの書き起こしが含まれています。 出力をモード text に設定すると、モデルからの音声出力が無効になります。

output_modalities?: ("text" | "audio")[]

プロパティ値

("text" | "audio")[]

継承VoiceAgentRealtimeResponseBase.output_modalities

status

応答の最終状態(completed、 cancelled、 failed、または incomplete、 in_progress)。

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

プロパティ値

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

VoiceAgentRealtimeResponseBase.statusから引き継ぎました

status_details

状況に関する追加情報。

status_details?: RealtimeResponseStatusDetails

プロパティ値

RealtimeResponseStatusDetails

継承VoiceAgentRealtimeResponseBase.status_details

usage

応答の利用統計は請求に対応します。 リアルタイムAPIセッションは会話コンテキストを維持し、新しいアイテムを会話に追加するため、前のターンからの出力(テキストおよび音声トークン)が後のターンの入力となります。

usage?: RealtimeResponseUsage

プロパティ値

RealtimeResponseUsage

VoiceAgentRealtimeResponseBase.usageから継承