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
conversation
控制响应被添加到哪个对话中。 目前支持 auto 和 none,默认 auto 值为。 该 auto 值意味着响应内容将被添加到默认对话中。 将此设置为 以 none 创建带外响应,不会将项目添加到默认对话中。
conversation?: "auto" | "none"
属性值
"auto" | "none"
input
要包含在模型的提示中的输入项。 使用该字段会为该响应创建一个新的上下文,而不是使用默认对话。 空数组 [] 将清除本次回复的上下文。
请注意,这可以包括使用其 id 引用会话中之前出现的项目。
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