VoiceAgentResponseCreateParams interface

語音代理 response.create 事件接受的參數。

屬性

audio

針對回應的音訊設定。

conversation

控制回應會加入哪個對話。 目前支援 auto 和 none,預設 auto 值為。 這個 auto 值表示回應的內容會加入預設對話中。 設定為 以 none 建立一個帶外回應,不會將項目加入預設對話。

input

對話項目作為內嵌回應輸入。

instructions

加在模型呼叫前面的預設系統指示 (亦即系統訊息)。 此欄位可讓客戶端引導模型以取得所需的回應。 模型可以指示回應內容和格式(例如“非常簡潔”、“行為友好”、“以下是良好的回應範例”)和音訊行為(例如,“快速說話”、“插入情感到您的聲音”、“經常笑”)。 模型不保證遵循這些指示,但這些指示為模型提供了實現期望行為的指引。 請注意,伺服器會設定預設指令,若未設定此欄位,會被使用,且會在會話開始時的事件中可見 session.created 。

interim_response

此回應的臨時回應設定。

max_output_tokens

單一助理回應的最大輸出標記數,包含工具呼叫。 提供介於 1 到 4096 之間的整數來限制輸出標記,或使用 inf 來指定該模型的最大可用標記數。 預設為 inf。

metadata

自訂字串鍵值對以與回應關聯。

output_modalities

回應可能會回歸的模式。

parallel_tool_calls

模型是否能同時呼叫多個工具。 僅有推理即時模型支持,例如 gpt-realtime-2。

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

自訂字串鍵值對以與回應關聯。

metadata?: Metadata

屬性值

output_modalities

回應可能會回歸的模式。

output_modalities?: VoiceOutputModality[]

屬性值

parallel_tool_calls

模型是否能同時呼叫多個工具。 僅有推理即時模型支持,例如 gpt-realtime-2。

parallel_tool_calls?: boolean

屬性值

boolean

pre_generated_assistant_message

用預先產生的助理訊息開始回應。

pre_generated_assistant_message?: RealtimeConversationItemUnion

屬性值

reasoning

使用具推理能力的即時模型時,回應的推理設定。

reasoning?: RealtimeReasoning

屬性值

tools

模型可用的工具。

tools?: (MCPTool | RealtimeFunctionTool)[]

屬性值

tool_choice

模型如何選擇工具。 提供其中一個字串模式,或強制執行特定函式/MCP 工具。

tool_choice?: ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions

屬性值