Qwen-Audio Realtime API的客户端事件参考。
用户指南:实时语音对话(Qwen-Audio-Realtime)。如需了解事件交互时序,请参见WebSocket API。
说明:建立连接后,发送此事件更新会话的默认配置。仅包含需要变更的字段,未传字段保持原值。服务端收到后校验参数,若参数不合法则返回错误,若参数合法则应用更改并返回完整配置。
语言配置(qwen-audio-3.1-realtime-plus) 连接
Function Calling:
声纹注册(voiceprint_audio_urls):
说明:追加音频数据到输入缓冲区。应持续、高频发送(如每 20~40 ms 一帧)。此事件无服务端确认回包。
说明:**仅 push-to-talk 模式。**将缓冲区音频提交为一条用户消息。提交后不会自动触发推理,需要发送
说明:**仅 push-to-talk 模式。**清空缓冲区中尚未提交的音频。server_vad / smart_turn 模式下此事件被忽略。服务端以
说明:手动向对话上下文插入一条对话项。可用于注入历史上下文、补充文本信息,或写回 Function Calling 的工具执行结果。
注入用户文本消息:
写回 Function Calling 结果:
说明:查询服务端存储的某条对话项。返回的音频类型 content 仅包含转写文本(
说明:从对话上下文中删除指定对话项。服务端以
说明:显式触发一次模型推理。各模式下的行为如下:
说明:取消当前正在进行的推理。已输出的部分文本会写入 item 链表,服务端返回
session.update
说明:建立连接后,发送此事件更新会话的默认配置。仅包含需要变更的字段,未传字段保持原值。服务端收到后校验参数,若参数不合法则返回错误,若参数合法则应用更改并返回完整配置。
turn_detection 仅在首次发送音频之前(IDLE 状态)允许修改。qwen-audio-3.1-realtime-plus 后,可发送以下 session.update 事件,分别将输入音频源语种设置为中文、输出音频目标语种设置为英语。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 session.update。 |
| session | object | (可选) 会话配置。 |
| session.modalities | array | (可选) 模型输出模态设置,可选值:
|
| session.voice | string | (可选) TTS 音色名称,3.1 Plus 的默认值为 longanqian_v3.1,3.0 Plus/Flash 的默认值为 longanqian。支持系统音色和声音复刻音色,仅可在第一次 session.update 中设置,后续传入将被忽略。
qwen-audio-3.1-realtime-plus 后,在首次 session.update 中设置音色,例如: |
| session.enable_speech_emotion | boolean | (可选) 是否开启情绪增强功能。开启后,回复音色的情绪变化更明显。默认值:true。可选值:true、false。 |
| session.instructions | string | (可选) 系统指令,用于设定模型的角色身份、回答风格和行为偏好。对整个会话生效。 |
| session.input_audio_format | string | (可选) 输入音频格式。当前仅支持 pcm(16kHz 16bit 单声道),为默认值。仅在首次发送音频之前(IDLE 状态)允许修改。 |
| session.output_audio_format | string | (可选) 输出音频格式。当前仅支持 pcm(24kHz 16bit 单声道),为默认值。 |
| session.input_audio_transcription | object | (可选) 输入音频转写配置。适用于 qwen-audio-3.1-realtime-plus。 |
| session.input_audio_transcription.language | string | (可选) 输入音频的源语种。 可选值:
|
| session.output_audio | object | (可选) 输出音频配置。适用于 qwen-audio-3.1-realtime-plus。 |
| session.output_audio.language | string | (可选) 输出音频的目标语种。 该参数作用于语音合成(TTS):会尽可能让语音输出使用目标语种,但不保证一定生效,也不会改变模型回复文本的语种。如需模型生成目标语种的文本,请在提示词中明确要求,例如通过 instructions 指定回答语言。 可选值:
|
| session.max_history_turns | integer | (可选) 允许单次请求的最大历史 QA 轮数。取值范围为 1-50,默认值为 20。 |
| session.enable_search | boolean | (可选) 适用于 qwen-audio-3.1-realtime-plus、qwen-audio-3.0-realtime-plus 和 qwen-audio-3.0-realtime-flash 模型。 是否开启联网搜索。默认值:false。开启后,模型可根据实时问题自主判断是否进行联网搜索。 > tools 与 enable_search 不可同时启用。 |
| session.search_options | object | (可选) 联网搜索配置,仅在 enable_search 为 true 时生效。 |
| session.search_options.enable_source | boolean | (可选) 是否返回搜索结果来源。设置为 true 时返回。 |
| session.tools | array | (可选) Function Calling 工具定义列表。配置后模型可根据用户输入自主决定是否调用工具。 |
| session.tools.type | string | (必选) 固定为 function。 |
| session.tools.function.name | string | (必选) 工具函数名称。 |
| session.tools.function.description | string | (可选) 对工具函数功能的描述,模型据此判断是否调用该工具。 |
| session.tools.function.parameters | object | (可选) 对工具函数入参的描述,模型据此提取所需入参。若函数无需入参,可不指定。 |
| session.tools.function.parameters.type | string | (必选) 固定为 object。 |
| session.tools.function.parameters.properties | object | (可选) 描述各入参的名称、数据类型与说明。 |
| session.tools.function.parameters.required | array | (可选) 指定哪些入参为必填项。 |
| session.turn_detection | object|null | (可选) 轮次检测配置。设为 null 可切换为 push-to-talk 模式(手动提交音频并触发推理)。若不提供此字段,系统将使用默认参数启用 VAD。 |
| session.turn_detection.type | string | (可选) VAD 类型,可选值:
|
| session.turn_detection.threshold | float | (可选) VAD灵敏度,仅在 server_vad 模式下生效(smart_turn 模式下无效)。值越低,VAD越灵敏,越容易将微弱声音(包括背景噪音)识别为语音;值越高,越不灵敏,需要更清晰、音量更大的语音才能触发。 取值范围为[-1.0, 1.0],默认值为 0.5。 |
| session.turn_detection.silence_duration_ms | integer | (可选) 语音结束后需保持静音的最短时间(毫秒),仅在 server_vad 模式下生效(smart_turn 模式下无效)。超时即触发模型响应。值越低,响应越快,但可能在短暂停顿时误触发。 取值范围为[200, 6000],默认值为 800。对话场景推荐 400-800。 |
| session.turn_detection.voiceprint_audio_urls | array | (可选) 仅在 smart_turn 模式下生效。目标用户预录音频的公网可访问 URL 列表,用于说话人增强。传入后,模型将在双工对话中精准锁定目标说话人,有效忽略旁人声音与背景噪声。最多支持 5 个 URL。音频格式要求:16kHz PCM 或 WAV。 提示: 该参数仅在第一次发送 session.update 事件时可配置,后续传入该字段将被忽略。 |
input_audio_buffer.append
说明:追加音频数据到输入缓冲区。应持续、高频发送(如每 20~40 ms 一帧)。此事件无服务端确认回包。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 input_audio_buffer.append。 |
| audio | string | (必选) Base64 编码的音频数据。 |
input_audio_buffer.commit
说明:**仅 push-to-talk 模式。**将缓冲区音频提交为一条用户消息。提交后不会自动触发推理,需要发送 response.create 手动触发。
server_vad / smart_turn 模式下此事件被忽略。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 input_audio_buffer.commit。 |
input_audio_buffer.clear
说明:**仅 push-to-talk 模式。**清空缓冲区中尚未提交的音频。server_vad / smart_turn 模式下此事件被忽略。服务端以 input_audio_buffer.cleared 事件响应。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 input_audio_buffer.clear。 |
conversation.item.create
说明:手动向对话上下文插入一条对话项。可用于注入历史上下文、补充文本信息,或写回 Function Calling 的工具执行结果。
若
item.id 已存在于对话中,会返回错误并拒绝创建。| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 conversation.item.create。 |
| previous_item_id | string | (可选) 指定新项插入到哪条对话项之后。不传时追加到对话末尾。 |
| item | object | (必选) 要创建的对话项。 |
| item.id | string | (可选) 对话项的唯一标识符。不传时由服务端自动生成。若指定的 ID 已存在于对话中,会返回错误。 |
| item.type | string | (必选) 对话项类型,可选值:
|
| item.role | string | (message 类型必选) 消息角色,可选值:system、user、assistant。 |
| item.content | array | (message 类型必选) 消息内容列表。每个元素包含 type 和对应的数据字段。 |
| item.content.system | input_text | :系统消息,必填字段 text。 user
|
| item.content.assistant | output_text | :助手文本输出,必填字段 text。 |
| item.call_id | string | (function_call / function_call_output 类型必选) 函数调用的唯一标识符,用于关联请求和结果。 |
| item.name | string | (function_call 类型必选) 要调用的函数名称。 |
| item.arguments | string | (function_call 类型必选) 函数调用参数,JSON 字符串格式。 |
| item.output | string | (function_call_output 类型必选) 工具执行结果,JSON 字符串格式。 |
conversation.item.retrieve
说明:查询服务端存储的某条对话项。返回的音频类型 content 仅包含转写文本(transcript),不包含原始音频数据。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 conversation.item.retrieve。 |
| item_id | string | (必选) 要查询的对话项 ID。服务端以 conversation.item.retrieved 事件返回查询结果。 |
conversation.item.delete
说明:从对话上下文中删除指定对话项。服务端以 conversation.item.deleted 事件确认。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 conversation.item.delete。 |
| item_id | string | (必选) 要删除的对话项 ID。 |
response.create
说明:显式触发一次模型推理。各模式下的行为如下:
- push-to-talk 模式:必须手动调用,需先通过
input_audio_buffer.commit提交缓冲区音频或写入function_call_output后触发。当前有响应正在生成时不允许重复触发。 - server_vad 模式:通常由服务端自动触发。当前无响应正在生成时,客户端也允许手动调用;有响应正在生成时不允许重复触发。
- smart_turn 模式:等待用户下一轮输入时允许调用。当前处于一个 turn 内时(收到
input_audio_buffer.speech_started到response.done期间)不允许重复触发。
response 字段可选,用于覆盖本轮推理的会话默认配置。Function Calling 场景下,客户端写入 function_call_output 后也通过该事件触发二轮推理。
server_vad / smart_turn 模式下,手动触发的推理仍可能被新语音打断。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 response.create。 |
| response | object | (可选) 用于覆盖本轮推理的会话默认配置。不传时使用当前会话配置。 |
| response.modalities | array | (可选) 覆盖本轮的输出模态设置。可选值与 session.update 中的 modalities 一致。 |
| response.voice | string | (可选) 覆盖本轮的 TTS 音色。 |
response.cancel
说明:取消当前正在进行的推理。已输出的部分文本会写入 item 链表,服务端返回 status=cancelled 的 response.done。
若当前无进行中的推理,返回错误。
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | (必选) 事件类型,固定为 response.cancel。 |