VoiceAgentDefinition interface
ボイスエージェントの定義です。 その構成(モデル、説明書、音声、ツール、オプションアバター)が、管理された音声間通話の体験を支えています。
GET /agents/{agent_name}/endpoint/protocols/voiceを通じてリアルタイムの音声セッションを確立しましょう。 作成や更新のたびに、新しい不変のバージョンが生成されます。
- Extends
プロパティ
| audio | 音声構成には、入出力フォーマット、音声、ターン検出、ノイズリダクション、文字起こしが含まれます。 これらの値はセッションのデフォルトであり、クライアントは接続時にサポートされているフィールドを上書きすることができます。 |
| avatar | オプションのアバター設定。 これらの値はセッションのデフォルトであり、接続時に上書きされることがあります。 |
| conversation_engine | このボイスエージェントの会話処理を担当するエンジンです。 この性質のうち正確に1つとモデル裏付けの構成( |
| greeting | オプションでセッション開始の挨拶。 テンプレートモードは正確なレンダリングテキストを読みます。LLM生成モードはセッションモデルに最初の応答を書かせ、設定済みツールを使用することがあります。 |
| include | サービス出力に含める追加のフィールド。 |
| instructions | モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。
|
| interim_response | 遅延やツール実行のための中間応答設定。 |
| kind | 音声エージェントの定義のための親切な識別器です。 常に |
| max_output_tokens | 1つの応答に対する最大出力トークン数。 |
| model | このエージェントに使うモデル。 モデルバックのボイスエージェントには |
| model_type | この声優のモデルがどのようにサービスされているか。 モデルバックのボイスエージェントには |
| output_modalities | その出力モダリティはエージェントが生み出すものです。 既定値は |
| parallel_tool_calls | モデルが複数のツールを並列に呼び出しできるかどうか。 |
| store | このエージェントとの会話が継続されているかどうか。 単一のオールオアゼロの永続スイッチで、デフォルトで |
| structured_inputs | プロンプトテンプレートの置換に参加する構造化入力のセットで、ライブセッション開始前にセッションごとにレンダリングされます。 |
| subagent_config | 兄弟のFoundryテキストエージェント向けのオプション設定で、このボイスエージェントはバックグラウンドスペシャリストとして相談することができます。 |
| tools | ボイスエージェントが使うツール。 サポートされるツールの種類には、 |
| tool_choice | モデルが生成される回答のためのツールの選択方法。
|
継承されたプロパティ
| rai_config | 責任ある AI (RAI) コンテンツのフィルタリングと安全機能の構成。 |
プロパティの詳細
audio
音声構成には、入出力フォーマット、音声、ターン検出、ノイズリダクション、文字起こしが含まれます。 これらの値はセッションのデフォルトであり、クライアントは接続時にサポートされているフィールドを上書きすることができます。
audio?: VoiceAgentAudioConfigプロパティ値
avatar
オプションのアバター設定。 これらの値はセッションのデフォルトであり、接続時に上書きされることがあります。
avatar?: VoiceAgentAvatarConfigプロパティ値
conversation_engine
このボイスエージェントの会話処理を担当するエンジンです。 この性質のうち正確に1つとモデル裏付けの構成(modelmodel_type)が提供されなければなりません。 この性質が提供されている場合、model_type、model、instructions、tools、tool_choiceは省略されなければならず、会話論理をrequiredるgreeting.tool_choiceもありません。なぜなら、会話ロジックはエンジンが所有しているからです。 初期実装ではホストエージェントエンジンがサポートされています。
conversation_engine?: VoiceConversationEngineUnionプロパティ値
greeting
オプションでセッション開始の挨拶。 テンプレートモードは正確なレンダリングテキストを読みます。LLM生成モードはセッションモデルに最初の応答を書かせ、設定済みツールを使用することがあります。
greeting?: VoiceAgentGreetingConfigUnionプロパティ値
include
サービス出力に含める追加のフィールド。
include?: VoiceAgentSessionIncludeOption[]プロパティ値
instructions
モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。
structured_inputsによるテンプレート置換をサポートし、ライブセッション開始前にセッションごとにレンダリングされます。
instructions?: stringプロパティ値
string
interim_response
遅延やツール実行のための中間応答設定。
interim_response?: VoiceAgentInterimResponseConfigUnionプロパティ値
kind
音声エージェントの定義のための親切な識別器です。 常に voice です。
kind: "voice"プロパティ値
"voice"
max_output_tokens
model
このエージェントに使うモデル。 モデルバックのボイスエージェントには model_type で必須で、 conversation_engine が提供される場合は省略されます。 モデルはリアルタイムまたはカスケード音声に対応しなければなりません。
model?: stringプロパティ値
string
model_type
この声優のモデルがどのようにサービスされているか。 モデルバックのボイスエージェントには model で必須で、 conversation_engine が提供される場合は省略されます。 これは、サービスが選択したモデルから派生するアーキテクチャ(リアルタイムまたはカスケード)とは独立しています。
model_type?: VoiceModelTypeプロパティ値
output_modalities
その出力モダリティはエージェントが生み出すものです。 既定値は ["audio"] です。
animation そしてアバターが設定されると avatar が利用可能です。
output_modalities?: VoiceOutputModality[]プロパティ値
parallel_tool_calls
モデルが複数のツールを並列に呼び出しできるかどうか。
parallel_tool_calls?: booleanプロパティ値
boolean
store
このエージェントとの会話が継続されているかどうか。 単一のオールオアゼロの永続スイッチで、デフォルトで false (プライバシー保護:デフォルトでオフ)に切り替えます。
true時には、Foundryは会話全体――トランスクリプト/イベントタイムラインと生の音声――を継続して保存します。
falseしても何も維持されず、会話も表面化しません。 音声ログ制御は別個ではなく、音声はこのスイッチの一部としてのみ永続化されます。 レイテンシ/パフォーマンステレメトリー(例:最初の音声までの時間、トークン間遅延、中断)は観測可能性のみ(顧客トレース/アプリインサイト)であり、永続会話内容には含まれません。
store?: booleanプロパティ値
boolean
structured_inputs
プロンプトテンプレートの置換に参加する構造化入力のセットで、ライブセッション開始前にセッションごとにレンダリングされます。
structured_inputs?: Record<string, StructuredInputDefinition>プロパティ値
Record<string, StructuredInputDefinition>
subagent_config
兄弟のFoundryテキストエージェント向けのオプション設定で、このボイスエージェントはバックグラウンドスペシャリストとして相談することができます。
subagent_config?: VoiceAgentSubagentConfigプロパティ値
tools
ボイスエージェントが使うツール。 サポートされるツールの種類には、 function (クライアントが実行)、 mcp、 system (サービス管理セッション制御)、 toolboxがあります。
web_search、azure_ai_search、openapiなどのサーバーサイドツールは、直接宣言されるのではなく、ツールボックスを通じて提供されます。
tools?: VoiceAgentToolUnion[]プロパティ値
tool_choice
モデルが生成される回答のためのツールの選択方法。
none ツール呼び出しを防ぎ、モデルに判断させる auto 、 required 少なくとも1つのツール呼び出しが必要で、オブジェクトで特定の関数やMCPツールを選択できます。
既定値は auto です。
tool_choice?: VoiceAgentToolChoiceプロパティ値
継承されたプロパティの詳細
rai_config
責任ある AI (RAI) コンテンツのフィルタリングと安全機能の構成。
rai_config?: RaiConfig