Qwen-Audio Realtime API的客户端事件参考。
用户指南:实时语音对话(Qwen-Audio-Realtime)。如需了解事件交互时序,请参见WebSocket API。
session.update
说明:建立连接后,发送此事件更新会话的默认配置。仅包含需要变更的字段,未传字段保持原值。服务端收到后校验参数,若参数不合法则返回错误,若参数合法则应用更改并返回完整配置。
说明turn_detection 仅在首次发送音频之前(IDLE 状态)允许修改。
type 事件类型,固定为 session 会话配置。 | 以下示例适用于 语言配置(qwen-audio-3.1-realtime-plus / qwen-audio-3.1-realtime-flash)连接 Function Calling: 声纹注册(voiceprint_audio_urls): |
input_audio_buffer.append
说明:追加音频数据到输入缓冲区。应持续、高频发送(如每 20~40 ms 一帧)。此事件无服务端确认回包。
type 事件类型,固定为 audio Base64 编码的音频数据。 | |
input_audio_buffer.commit
说明:仅 push-to-talk 模式。将缓冲区音频提交为一条用户消息。提交后不会自动触发推理,需要发送 response.create 手动触发。
server_vad / smart_turn / smart_turn_v2 模式下此事件被忽略。
type 事件类型,固定为 | |
input_audio_buffer.clear
说明:仅 push-to-talk 模式。清空缓冲区中尚未提交的音频。server_vad / smart_turn / smart_turn_v2 模式下此事件被忽略。服务端以 input_audio_buffer.cleared 事件响应。
type 事件类型,固定为 | |
conversation.item.create
说明:手动向对话上下文插入一条对话项。可用于注入历史上下文、补充文本信息,或写回 Function Calling 的工具执行结果。
说明若 item.id 已存在于对话中,会返回错误并拒绝创建。
type 事件类型,固定为 previous_item_id 指定新项插入到哪条对话项之后。不传时追加到对话末尾。 item 要创建的对话项。 | 注入用户文本消息: 写回 Function Calling 结果: |
conversation.item.retrieve
说明:查询服务端存储的某条对话项。返回的音频类型 content 仅包含转写文本(transcript),不包含原始音频数据。
type 事件类型,固定为 item_id 要查询的对话项 ID。服务端以 | |
conversation.item.delete
说明:从对话上下文中删除指定对话项。服务端以 conversation.item.deleted 事件确认。
type 事件类型,固定为 item_id 要删除的对话项 ID。 | |
response.create
说明:显式触发一次模型推理。各模式下的行为如下:
- push-to-talk 模式:必须手动调用,需先通过
input_audio_buffer.commit提交缓冲区音频或写入function_call_output后触发。当前有响应正在生成时不允许重复触发。 - server_vad 模式:通常由服务端自动触发。当前无响应正在生成时,客户端也允许手动调用;有响应正在生成时不允许重复触发。
- smart_turn / smart_turn_v2 模式:等待用户下一轮输入时允许调用。当前处于一个 turn 内时(收到
input_audio_buffer.speech_started到response.done期间)不允许重复触发。
response 字段可选,用于覆盖本轮推理的会话默认配置。Function Calling 场景下,客户端写入 function_call_output 后也通过该事件触发二轮推理。
说明server_vad / smart_turn / smart_turn_v2 模式下,手动触发的推理仍可能被新语音打断。
type 事件类型,固定为 response 用于覆盖本轮推理的会话默认配置。不传时使用当前会话配置。 属性 modalities 覆盖本轮的输出模态设置。可选值与 voice 覆盖本轮的 TTS 音色。 | |
response.cancel
说明:取消当前正在进行的推理。已输出的部分文本会写入 item 链表,服务端返回 status=cancelled 的 response.done。
若当前无进行中的推理,返回错误。
type 事件类型,固定为 | |