VoiceAgentResponseCreateParams interface
ボイスエージェントがイベント response.create 受け入れるパラメータ。
プロパティ
| audio | レスポンス固有の音声設定。 |
| conversation | どの会話に返答を追加するかを制御します。 現在、 |
| input | 会話項目をインラインの応答入力として使う。 |
| instructions | モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (例: "非常に簡潔にする"、"優しく行動する"、"ここでは良い応答の例") とオーディオ動作 (たとえば、"すばやく話す"、"声に感情を挿入する"、"頻繁に笑う") に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。
サーバーは、このフィールドが設定されておらず、セッションの開始時に |
| interim_response | この対応のための暫定対応設定。 |
| max_output_tokens | ツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 出力トークンを制限するには 1 から 4096 までの整数を指定するか、特定のモデルで使用可能な最大トークンに対して |
| metadata | 応答に関連付けるカスタム文字列のキー-値ペア。 |
| output_modalities | 反応が戻る可能性のあるモダリティ。 |
| parallel_tool_calls | モデルが複数のツールを並列に呼び出しできるかどうか。
|
| pre_generated_assistant_message | 応答を開始するために事前に生成されたアシスタントメッセージを使用します。 |
| reasoning | 推論可能なリアルタイムモデルを用いた場合の回答の推論設定。 |
| tools | モデルで使用できるツール。 |
| tool_choice | モデルがツールを選択する方法。 文字列モードのいずれかを提供するか、特定の関数やMCPツールを強制的に設定してください。 |
プロパティの詳細
audio
レスポンス固有の音声設定。
audio?: PickPropertiesVoiceAgentAudioConfigプロパティ値
conversation
どの会話に返答を追加するかを制御します。 現在、 auto と noneをサポートしており、 auto がデフォルト値です。
auto値は、応答の内容がデフォルトの会話に加えられることを意味します。 これを none に設定すると、デフォルトの会話に項目を追加しないアウトオブバンド応答が作成されます。
conversation?: "auto" | "none"プロパティ値
"auto" | "none"
input
会話項目をインラインの応答入力として使う。
input?: RealtimeConversationItemUnion[]プロパティ値
instructions
モデル呼び出しの前に付加される既定のシステム命令 (つまり、システム メッセージ)。 このフィールドを使用すると、クライアントは必要な応答に基づいてモデルをガイドできます。 モデルは、応答のコンテンツと形式 (例: "非常に簡潔にする"、"優しく行動する"、"ここでは良い応答の例") とオーディオ動作 (たとえば、"すばやく話す"、"声に感情を挿入する"、"頻繁に笑う") に対して指示できます。 この命令はモデルに従う保証はありませんが、目的の動作に関するガイダンスをモデルに提供します。
サーバーは、このフィールドが設定されておらず、セッションの開始時に session.created イベントに表示される場合に使用される既定の命令を設定します。
instructions?: stringプロパティ値
string
interim_response
この対応のための暫定対応設定。
interim_response?: VoiceAgentInterimResponseConfigUnionプロパティ値
max_output_tokens
ツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 出力トークンを制限するには 1 から 4096 までの整数を指定するか、特定のモデルで使用可能な最大トークンに対して inf します。 既定値は inf です。
max_output_tokens?: number | "inf"プロパティ値
number | "inf"
metadata
output_modalities
parallel_tool_calls
モデルが複数のツールを並列に呼び出しできるかどうか。
gpt-realtime-2のような推論的なリアルタイムモデルによってのみ支援されます。
parallel_tool_calls?: booleanプロパティ値
boolean
pre_generated_assistant_message
応答を開始するために事前に生成されたアシスタントメッセージを使用します。
pre_generated_assistant_message?: RealtimeConversationItemUnionプロパティ値
reasoning
tools
tool_choice
モデルがツールを選択する方法。 文字列モードのいずれかを提供するか、特定の関数やMCPツールを強制的に設定してください。
tool_choice?: ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions