文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>腾讯云智能体开发平台>应用接口文档>对话端接口文档V2（WebSocket）

对话端接口文档V2（WebSocket）

最近更新时间：2026-03-19 12:11:31

我的收藏

本页目录：

WebSocket 是面向连接的，全双工通道。建立连接前需要先从服务端获取 Token。通过这个 token 才能与服务端创建 WebSocket 连接。Token 仅建立连接时有效，连接建立成功后废弃。
接入流程图：




1. 获取建立 WebSocket 连接的 Token

1.1 调用方式

通过腾讯云 SDK 调用 GetWsToken 接口获取 Token，可参考 GetWsToken 文档。
说明：
获取的 Token 仅供一次会话连接使用，并且会过期，请在获取到 Token 后及时建立长连接，如需建立其他连接，需要重新获取 Token。

1.2 如何获取 AppKey

在应用管理界面，找到您处于运行中的应用（需要先发布），单击调用，会弹出“调用信息”窗口。



在调用信息窗口可以看到 AppKey，单击复制即可。




2. 使用 Token 建立 WebSocket 连接

请求地址：wss://wss.lke.cloud.tencent.com/adp/v2/chat/conn/?language=zh-CN&EIO=4&transport=websocket
请求协议：Socket.IO v4 （参考文档）

2.1 建立连接

WebSocket 连接建立成功后，服务器回包如下所示：
0{"sid":"xxx","upgrades":[],"pingInterval":25000,"pingTimeout":5000}

2.2 传递 token 鉴权

通过 Socket.IO 的 auth 消息传递。
在建立连接并收到服务器回包后，发送 Token 鉴权。发送 Token 格式如下所示：
40{"token":"xx-xx-xx-xx-xx"}

2.3 处理心跳包

服务器发送的心跳包如下（"2"是心跳包的内容）：
2
此时客户端需要响应（"3"是需要响应的内容）：
3
注意：
Socket.IO v4 有心跳包， 必须处理，否则会被服务器断开连接。


3. WebSocket 支持的事件

Socket.IO 事件格式如下，实现时需要注意其结构。建议尽可能使用 Socket.IO 提供的 标准 Client。
42["类型",{事件体}]

例如：
42["request",{对话请求事件体，请参考下面各个不同事件的数据结构}]

3.1 对话请求事件

事件名：request
事件方向：前端 > 后端
注意：
发送 request 事件前，需要先发布应用。
用户发出一条消息（对话请求事件）时，服务器会返回一个请求确认事件，以便确认消息被服务端收到并对应更新消息 ID、时间戳、消息脱敏等。

数据结构：

名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 request。
Request
Request
是
请求信息。

Request 请求信息的数据结构：

名称
类型
是否必填
说明
RequestId
String
否
请求 ID，用于标识一个请求（作消息串联，建议每个请求使用不同的 RequestId）。
为了便于问题排查，建议必填。
参数长度：32-64个字符。
校验规则： ^[a-zA-Z0-9_-]{32,64}$ ，一般可以用 uuid 来生成该值。
uuid 示例：1b9c0b03-dc83-47ac-8394-b366e3ea67ef
ConversationId
String
是
会话 ID，用于标识一个会话（外部系统提供，建议不同的用户端会话传入不同的ConversationId，否则同一个应用下的不同用户的消息记录会串掉）。
参数长度：32-64个字符。
校验规则： ^[a-zA-Z0-9_-]{32,64}$ ，一般可以用 uuid 来生成该值。
uuid 示例：1b9c0b03-dc83-47ac-8394-b366e3ea67ef
Contents
Array of Content
是
消息内容信息列表。
StreamingThrottle
Number
否
流式回复频率控制：控制应用回包频率。该值表示应用每积攒多少字符向调用方回包一次，值越小回包越频繁（体验上越流畅，但流量开销也越大）。当不传值或者为 0 时以系统配置为准。
默认值：5
建议最大值：100
注意：
该设置项也不会加快大模型输出的时间，只是改变了向调用方回包的频率。因此如果设置很大，则会出现很长时间没有回包的现象。
SystemRole
String
否
角色指令（提示词）, 为空时使用应用配置默认设定，填写时取当前值。
最大值限制： 不同模型最大值有差异，请参考 ListModel 接口的 RoleLenLimit。
Incremental
Boolean
否
控制回复的文本内容是以文本增量事件（text.delta）还是文本替换事件（text.replace）返回，默认 false 。
注意：
Incremental 为 true 时，文本内容并不是完全以文本增量事件返回，ADP后台在发现需要修改已经返回的内容时，会返回文本替换事件。
SearchNetwork
String
否
是否开启联网搜索。取值范围：
空字符串：跟随应用配置
enable：打开联网搜索
disable：关闭联网搜索
注意：
应用配置在未开启联网搜索时，如上取值字段无意义。
ModelName
String
否
支持在对话的过程中传入指定模型， 同一个 session_id 下传入不同的模型名称可以保持上下文之间的关联。
当前支持下面几个自定义模型：
Youtu/youtu-mrc-pro：精调知识大模型高级版
Youtu/youtu-mrc-standard：精调知识大模型标准版
Hunyuan/hunyuan：混元大模型高级版
Hunyuan/hunyuan-standard：混元大模型标准版
Hunyuan/hunyuan-turbo：混元大模型Turbo版
Hunyuan/hunyuan-standard-256k：混元大模型长文本版
Hunyuan/hunyuan-role：混元大模型角色扮演版
Hunyuan/hunyuan-t1：混元大模型T1版
Hunyuan/hunyuan-turbos：混元大模型Turbos版
Hunyuan/hunyuan-2.0-thinking-251109：混元大模型2.0-Think
Hunyuan/hunyuan-2.0-instruct-251111：混元大模型2.0-Instruct
Deepseek/deepseek-r1-250528：DeepSeek-R1模型最新版
Deepseek/deepseek-v3-250324：DeepSeek-V3模型最新版
Deepseek/deepseek-v3.1：DeepSeek-V3.1模型
Deepseek/deepseek-v3.2：DeepSeek-V3.2模型
TCADP/glm-5：智谱GLM-5
TCADP/kimi-k2.5：Kimi K2.5
TCADP/minimax-m2.5：MiniMax M2.5
注意：
请确保账户下有足够的PU资源，避免在使用的过程中报错。
Stream
String
否
是否开启流式传输。取值范围：
空字符串：跟随应用配置
enable：流式传输
disable：非流式传输
WorkflowStatus
String
否
是否开启工作流。取值范围：
空字符串：跟随应用配置（页面无配置工作流开关的入口，默认是开启）
enable：开启工作流
disable：关闭工作流

示例：
[
  "request", 
  {
	"Type": "request",
	"Request": {
		"RequestId": "62bcA7Vknu-8384773123",
		"ConversationId": "a515696d-f934-4820-9b84-4e186f2cca4b",
		"Contents": [{
			"Type": "text",
			"Text": "给我生成一张小猫图片"
		}],
		"Incremental": true
	}
  }
]

3.2 请求确认事件

事件名：request_ack
事件方向：后端 > 前端
注意：
如果发送的请求事件因为安全审核被拦截，或者请求超过并发数被拦截，后台不会返回请求确认事件，而是返回错误事件

数据结构：

名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 request_ack。
RequestAck
Record
是
请求确认信息。
示例：
[
    "request_ack", 
    {
        "Type": "request_ack",
        "RequestAck": {
            "Role": "user",
            "RecordId": "p9G_20251220_225838_112_Pr4FhDcR",
            "ConversationId": "a515696d-f934-4820-9b84-4e186f2cca4b",
            "Status": "success",
            "StatusDesc": "请求成功",
            "Messages": [
                {
                    "Type": "question",
                    "MessageId": "rpl_p9G_20251220_225838_112_Pr4FhDcR",
                    "Name": "question",
                    "Title": "用户提问",
                    "Icon": "",
                    "Status": "success",
                    "StatusDesc": "",
                    "Contents": [
                        {
                            "Type": "text",
                            "Text": "给我生成一张小猫图片"
                        }
                    ],
                    "ExtraInfo": {
                        "Elapsed": "0",
                        "StartTime": "1766242718000"
                    }
                }
            ],
            "ExtraInfo": {
                "RequestId": "62bcA7Vknu-8384773123",
                "TraceId": "77fc0a9ce9ba9f3b511ac28ad05b5bab / p9G_20251220_225838_112_Pr4FhDcR",
                "Elapsed": "0",
                "StartTime": "1766242718000",
                "IsFromSelf": true,
                "IsLlmGenerated": false,
                "CanRating": false,
                "CanFeedback": false,
                "ReplyMethod": 0,
                "FromName": "",
                "FromAvatar": "",
                "HasRead": false
            }
        }
    }
]

3.3 响应创建事件

事件名：response.created
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 response.created。
Response
Record
是
响应信息。
示例:
[
    "response.created", 
    {
        "Type": "response.created",
        "Response": {
            "Role": "assistant",
            "RecordId": "09b_20251220_225838_205_QOy26o1I",
            "RelatedRecordId": "p9G_20251220_225838_112_Pr4FhDcR",
            "ConversationId": "a515696d-f934-4820-9b84-4e186f2cca4b",
            "Status": "processing",
            "StatusDesc": "",
            "ExtraInfo": {
                "RequestId": "62bcA7Vknu-8384773123",
                "TraceId": "77fc0a9ce9ba9f3b511ac28ad05b5bab / 09b_20251220_225838_205_QOy26o1I",
                "Elapsed": "613",
                "StartTime": "1766242718110",
                "IsFromSelf": false,
                "IsLlmGenerated": false,
                "CanRating": false,
                "CanFeedback": false,
                "ReplyMethod": 0,
                "FromName": "",
                "FromAvatar": "",
                "HasRead": false
            }
        }
    }
]

3.4 响应处理中事件

事件名：response.processing
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 response.processing。
Response
Record
是
响应信息。
示例：
[
    "response.processing", 
    {
        "Type": "response.processing",
        "Response": {
            "Role": "assistant",
            "RecordId": "09b_20251220_225838_205_QOy26o1I",
            "RelatedRecordId": "p9G_20251220_225838_112_Pr4FhDcR",
            "ConversationId": "a515696d-f934-4820-9b84-4e186f2cca4b",
            "Status": "processing",
            "StatusDesc": "调用思考模型",
            "ExtraInfo": {
                "RequestId": "62bcA7Vknu-8384773123",
                "TraceId": "77fc0a9ce9ba9f3b511ac28ad05b5bab / 09b_20251220_225838_205_QOy26o1I",
                "Elapsed": "3592",
                "StartTime": "1766242718110",
                "IsFromSelf": false,
                "IsLlmGenerated": false,
                "CanRating": false,
                "CanFeedback": false,
                "ReplyMethod": 0,
                "FromName": "",
                "FromAvatar": "",
                "HasRead": false
            }
        }
    }
]

3.5 消息增加事件

事件名：message.added
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 message.added。
Message
Message
是
消息信息。
示例：
[
    "message.added", 
    {
        "Type": "message.added",
        "Message": {
            "Type": "thought",
            "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
            "Name": "thought",
            "Title": "思考",
            "Icon": "https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon/thinking.png",
            "Status": "processing",
            "StatusDesc": "思考中",
            "ExtraInfo": {
                "Elapsed": "1785",
                "StartTime": "1766242718724",
                "AgentName": "TT专家智能体-莫娇-prod",
                "AgentIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1864611313395171328/1937770498688842432/image/KxWmEzYIEKTUASYsrNmK-1939497567585093952.png"
            }
        }
    }
]

3.6 消息处理中事件

事件名：message.processing
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 message.processing。
MessageId
String
是
处理中的消息 ID。
Message
Message
是
消息状态信息。
示例：
[
    "message.processing", 
    {
        "Type": "message.processing",
        "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
        "Message": {
            "Type": "thought",
            "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
            "Name": "thought",
            "Title": "思考",
            "Icon": "https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon/thinking.png",
            "Status": "processing",
            "StatusDesc": "思考中",
            "ExtraInfo": {
                "Elapsed": "1887",
                "StartTime": "1766242718724"
            }
        }
    }
]

3.7 内容增加事件

事件名：content.added
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 content.added。
MessageId
String
是
增加内容的消息对应的消息 ID。
ContentIndex
Number
是
增加内容的序号。
Content
Content
是
内容信息。
示例：
[
    "content.added", 
    {
        "Type": "content.added",
        "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
        "ContentIndex": 0,
        "Content": {
            "Type": "text",
            "Text": "当前"
        }
    }
]

3.8 文本内容增量事件

事件名：text.delta
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 text.delta。
MessageId
String
是
增加文本内容的消息对应的消息 ID。
ContentIndex
Number
是
增加文本内容的序号。
Text
String
是
增加的文本内容。
示例：
[
    "text.delta", 
    {
        "Type": "text.delta",
        "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
        "ContentIndex": 0,
        "Text": "任务"
    }
]

3.9 文本内容替换事件

事件名：text.replace
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 text.replace。
MessageId
String
是
替换文本内容的消息对应的消息 ID。
ContentIndex
Number
是
替换文本内容的序号。
Text
String
是
替换的文本内容。
示例：
[
    "text.replace", 
    {
        "Type": "text.replace",
        "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
        "ContentIndex": 0,
        "Text": "当前的任务是为用户生成"
    }
]

3.10 消息处理完成事件

事件名：message.done
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 message.done。
MessageId
String
是
处理完成的消息 ID。
Message
Message
是
处理完成的消息信息。
示例：
[
    "message.done", 
    {
        "Type": "message.done",
        "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
        "Message": {
            "Type": "thought",
            "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
            "Name": "thought",
            "Title": "思考",
            "Icon": "https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon/thinking.png",
            "Status": "success",
            "StatusDesc": "思考完成",
            "Contents": [
                {
                    "Type": "text",
                    "Text": "当前任务是为用户生成一张小猫图片，这在我的专业能力中不直接涉及图像创作，但我有能力调用文生图工具来完成这个需求。任务明确，不应再询问用户信息；直接执行文生图即可。"
                }
            ],
            "ExtraInfo": {
                "Elapsed": "2679",
                "StartTime": "1766242718724",
                "AgentName": "TT专家智能体-莫娇-prod",
                "AgentIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1864611313395171328/1937770498688842432/image/KxWmEzYIEKTUASYsrNmK-1939497567585093952.png"
            }
        }
    }
]

3.11 响应完成事件

事件名：response.completed
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 response.completed。
Response
Record
是
处理完成的完整响应内容。
示例：
[
    "response.completed", 
    {
        "Type": "response.completed",
        "Response": {
            "Role": "assistant",
            "RecordId": "09b_20251220_225838_205_QOy26o1I",
            "RelatedRecordId": "p9G_20251220_225838_112_Pr4FhDcR",
            "ConversationId": "a515696d-f934-4820-9b84-4e186f2cca4b",
            "Status": "success",
            "StatusDesc": "调用思考模型",
            "Messages": [
                {
                    "Type": "thought",
                    "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_0",
                    "Name": "thought",
                    "Title": "思考",
                    "Icon": "https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon/thinking.png",
                    "Status": "success",
                    "StatusDesc": "思考完成",
                    "Contents": [
                        {
                            "Type": "text",
                            "Text": "当前任务是为用户生成一张小猫图片，这在我的专业能力中不直接涉及图像创作，但我有能力调用文生图工具来完成这个需求。任务明确，不应再询问用户信息；直接执行文生图即可。"
                        }
                    ],
                    "ExtraInfo": {
                        "Elapsed": "2679",
                        "StartTime": "1766242718724",
                        "AgentName": "TT专家智能体-莫娇-prod",
                        "AgentIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1864611313395171328/1937770498688842432/image/KxWmEzYIEKTUASYsrNmK-1939497567585093952.png"
                    }
                },
                {
                    "Type": "tool_call",
                    "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_1",
                    "Name": "文生图",
                    "Title": "工具执行",
                    "Icon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/workflow-tool.svg",
                    "Status": "success",
                    "StatusDesc": "工具执行完成",
                    "Contents": [
                        {
                            "Type": "json_text",
                            "Text": "{\\"code\\":0,\\"msg\\":\\"ok\\",\\"output\\":\\"{\\\\\\"img_url\\\\\\":\\\\\\"https://edu-aigc-1307578727.cos.ap-guangzhou.tencentcos.cn/ai-image/2025-12-20/0df7d8d44ec94c3b87a87f132b421bb8.png\\\\\\",\\\\\\"request_id\\\\\\":\\\\\\"9dacdd61-485d-421d-8bd9-79449b85a1c2\\\\\\"}\\",\\"response\\":\\"\\"}"
                        }
                    ],
                    "ExtraInfo": {
                        "Elapsed": "5231",
                        "StartTime": "1766242721713",
                        "ToolName": "工作流/文生图",
                        "ToolIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/workflow-tool.svg"
                    }
                },
                {
                    "Type": "thought",
                    "MessageId": "prc_09b_20251220_225838_205_QOy26o1I_2",
                    "Name": "thought",
                    "Title": "思考",
                    "Icon": "https://lke-realtime-1251316161.cos.ap-guangzhou.myqcloud.com/icon/thinking.png",
                    "Status": "success",
                    "StatusDesc": "思考完成",
                    "Contents": [
                        {
                            "Type": "text",
                            "Text": "我已使用文生图工具生成了小猫图片并得到了返回的链接，接下来应直接向用户展示图片并用自然的语言收尾，然后结束任务。"
                        }
                    ],
                    "ExtraInfo": {
                        "Elapsed": "2190",
                        "StartTime": "1766242727002",
                        "AgentName": "TT专家智能体-莫娇-prod",
                        "AgentIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1864611313395171328/1937770498688842432/image/KxWmEzYIEKTUASYsrNmK-1939497567585093952.png"
                    }
                },
                {
                    "Type": "reply",
                    "MessageId": "rpl_09b_20251220_225838_205_QOy26o1I",
                    "Name": "reply",
                    "Title": "",
                    "Icon": "",
                    "Status": "success",
                    "StatusDesc": "回复完成",
                    "Contents": [
                        {
                            "Type": "text",
                            "Text": "好的，我和你一起构思了一个温暖简洁的场景，用柔和的色彩呈现了一只可爱的小猫，姿态悠闲，带着自然与生活的情趣。请看——\\n\\n![可爱的小猫](https://edu-aigc-1307578727.cos.ap-guangzhou.tencentcos.cn/ai-image/2025-12-20/0df7d8d44ec94c3b87a87f132b421bb8.png)\\n\\n在设计里，我们常说“器物承载寓意、意趣和道义”，其实小动物也能成为生活中温柔的陪伴与灵感的来源。希望这张图片能给你带来片刻的轻松与愉悦。"
                        }
                    ],
                    "ExtraInfo": {
                        "Elapsed": "1549",
                        "StartTime": "1766242729698"
                    }
                }
            ],
            "Procedures": [
                {
                    "Name": "thinking_model",
                    "Title": "调用思考模型",
                    "Status": "success",
                    "IntentCate": "",
                    "ResourceStatus": 0,
                    "StatInfos": [
                        {
                            "InputTokens": 2884,
                            "OutputTokens": 86,
                            "TotalTokens": 2970,
                            "ModelName": "100021406304-OpenAI/ouFPaKKL"
                        }
                    ],
                    "Type": "agent",
                    "Agent": {
                        "ModelName": "100021406304-OpenAI/ouFPaKKL",
                        "Input": "",
                        "Output": "[{\\"id\\":\\"call_af6a8234f2180102\\",\\"type\\":\\"function\\",\\"function\\":{\\"name\\":\\"文生图\\",\\"arguments\\":\\"{\\\\\\"prompt\\\\\\":\\\\\\"一只可爱的小猫，毛色柔和，姿态悠闲，场景温暖简洁，体现自然与生活情趣\\\\\\"}\\"},\\"index\\":0}]\\n",
                        "Content": "",
                        "RewriteQuery": ""
                    }
                },
                {
                    "Name": "tool_call",
                    "Title": "调用文生图",
                    "Status": "success",
                    "IntentCate": "",
                    "ResourceStatus": 0,
                    "Type": "agent",
                    "Agent": {
                        "ModelName": "",
                        "Input": "{\\"name\\":\\"文生图\\",\\"arguments\\":\\"{\\\\\\"prompt\\\\\\":\\\\\\"一只可爱的小猫，毛色柔和，姿态悠闲，场景温暖简洁，体现自然与生活情趣\\\\\\"}\\"}\\n",
                        "Output": "{\\"code\\":0,\\"msg\\":\\"ok\\",\\"output\\":\\"{\\\\\\"img_url\\\\\\":\\\\\\"https://edu-aigc-1307578727.cos.ap-guangzhou.tencentcos.cn/ai-image/2025-12-20/0df7d8d44ec94c3b87a87f132b421bb8.png\\\\\\",\\\\\\"request_id\\\\\\":\\\\\\"9dacdd61-485d-421d-8bd9-79449b85a1c2\\\\\\"}\\",\\"response\\":\\"\\"}",
                        "Content": "",
                        "RewriteQuery": ""
                    }
                },
                {
                    "Name": "thinking_model",
                    "Title": "调用思考模型",
                    "Status": "success",
                    "IntentCate": "",
                    "ResourceStatus": 0,
                    "StatInfos": [
                        {
                            "InputTokens": 3072,
                            "OutputTokens": 168,
                            "TotalTokens": 3240,
                            "ModelName": "100021406304-OpenAI/ouFPaKKL"
                        }
                    ],
                    "Type": "agent",
                    "Agent": {
                        "ModelName": "100021406304-OpenAI/ouFPaKKL",
                        "Input": "",
                        "Output": "[{\\"id\\":\\"call_fa9caa370c1d7aad\\",\\"type\\":\\"function\\",\\"function\\":{\\"name\\":\\"task_done\\",\\"arguments\\":\\"{\\\\\\"success\\\\\\": true, \\\\\\"final_response\\\\\\": \\\\\\"好的，我和你一起构思了一个温暖简洁的场景，用柔和的色彩呈现了一只可爱的小猫，姿态悠闲，带着自然与生活的情趣。请看——\\\\\\\\n\\\\\\\\n![可爱的小猫](https://edu-aigc-1307578727.cos.ap-guangzhou.tencentcos.cn/ai-image/2025-12-20/0df7d8d44ec94c3b87a87f132b421bb8.png)\\\\\\\\n\\\\\\\\n在设计里，我们常说“器物承载寓意、意趣和道义”，其实小动物也能成为生活中温柔的陪伴与灵感的来源。希望这张图片能给你带来片刻的轻松与愉悦。\\\\\\"}\\"},\\"index\\":0}]\\n",
                        "Content": "",
                        "RewriteQuery": ""
                    }
                }
            ],
            "StatInfo": {
                "InputTokens": 5956,
                "OutputTokens": 254,
                "TotalTokens": 6210,
                "TotalCost": "13137"
            },
            "ExtraInfo": {
                "RequestId": "62bcA7Vknu-8384773123",
                "TraceId": "77fc0a9ce9ba9f3b511ac28ad05b5bab / 09b_20251220_225838_205_QOy26o1I",
                "Elapsed": "13142",
                "StartTime": "1766242718110",
                "IsFromSelf": false,
                "IsLlmGenerated": true,
                "CanRating": true,
                "CanFeedback": false,
                "ReplyMethod": 18,
                "FromName": "专家智能体测试",
                "FromAvatar": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1864611313395171328/1937770498688842432/image/KxWmEzYIEKTUASYsrNmK-1939497567585093952.png",
                "HasRead": false
            }
        }
    }
]

3.12 角标增加事件

事件名：quote_info.added
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 quote_info.added。
MessageId
String
是
增加角标的消息对应的消息 ID。
ContentIndex
Number
是
增加角标内容的序号。
QuoteInfo
QuoteInfo
是
角标信息。
示例：
[
    "quote_info.added", 
    {
     	"Type": "quote_info.added",
     	"MessageId": "rpl_Uty_20251223_003736_015_GV5QLEq4",
        "ContentIndex": 0,
     	"QuoteInfo": {
      		"Position": 240,
      		"Index": 1
     	}
    }
]

3.13 引文增加事件

事件名：reference.added
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 reference.added。
MessageId
String
是
增加引文内容的消息对应的消息 ID。
ContentIndex
Number
是
增加引文内容的序号。
Reference
Reference
是
引文信息。
示例：
[
	"reference.added", 
    {
		"Type": "reference.added",
		"MessageId": "rpl_Uty_20251223_003736_015_GV5QLEq4",
        "ContentIndex": 0,
		"Reference": {
			"Index": 1,
			"Name": "深大新闻-深圳大学",
			"Type": 4,
			"WebSearchRefer": {
				"Url": "http://www.szu.edu.cn/index/sdxw.htm"
			}
		}
	}
]

3.14 错误事件

事件名：error
事件方向：后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 error。
Error
Error
是
错误信息。
示例：
[
	"error", 
    {
		"Type": "error",
		"Error": {
			"Code": 460501,
			"Message": "我无法回答这个问题，您可以尝试问我其它问题。",
			"RequestId": "A9EhrrijXs-5778188698",
			"TraceId": "fda66d6df4cc43128ca76852cca66191",
			"Elapsed": "165",
			"StartTime": "1766421936159"
		}
	}
]

3.15 点赞/点踩事件

事件名：rating
事件方向：前端 > 后端，后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 rating。
Rating
Rating
是
点赞/点踩信息。
示例：
[
    "rating", 
    {
        "Type": "rating",
        "Rating": {
            "RequestId": "",
            "RecordId": "09b_20251220_225838_205_QOy26o1I",
            "Score": 2,
            "Reasons": [
                "没有完成任务",
                "输出重复内容"
            ],
            "TraceId": "cee10b07ef4a475f8cf86e1ee6206ac9",
            "FeedbackContent": "其他"
        }
    }
]

3.16 停止生成事件

事件名：stop_generation
事件方向：前端 > 后端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 stop_generation。
StopGeneration
是
停止生成信息。
示例：
[
    "stop_generation", 
    {
        "Type": "stop_generation",
        "StopGeneration": {
            "RecordId": "wie_20251220_232620_332_SFx4EfUp"
        }
    }
]

3.17 重连事件

事件名：reconnect
事件方向：前端 > 后端，后端 > 前端
数据结构：
名称
类型
是否必填
说明
Type
String
是
事件类型，固定为 reconnect。
Reconnect
Reconnect
是
重连信息。
示例：
[
	"reconnect",
	{
		"Reconnect": {
			"RequestId": "62bcA7Vknu-8384773123",
			"RecordId": "fbY_20260126_171924_631_xPxGogj7"
		}
	}
]

4. 公共数据结构

Content

消息内容信息的数据结构：
名称
类型
是否必填
说明
Type
String
是
消息内容类型：
text：文本
image：图片
file：文件
custom_variables：自定义输入参数信息
widget_action：widget 动作信息
Text
String
否
文本内容。
Image
Image
否
图片信息。
File
FileInfo
否
文件信息。
CustomVariables
Map[String]String
否
自定义变量。
WidgetAction
否
Widget 动作信息。
QuoteInfos
Array of QuoteInfo
否
引用信息（可选）。
References
Array of Reference
否
参考文献信息（可选）。
OptionCards
Array of String
否
选项卡信息（可选）。
CustomParams
Array of String
否
用户自定义业务参数信息（可选）。
Sandbox
Sandbox
否
沙盒信息。
WebSearch
WebSearch
否
网页搜索内容。
FileCollection
否
文件收集信息。
RelatedRecordId
String
否
关联的 RecordId。
Widget
Widget
否
Widget 信息。

Image

图片信息的数据结构：
名称
类型
是否必填
说明
Url
String
是
文件 URL。
注意：
请使用上传到ADP的文件链接（参考离线文档上传），或者可以公开访问的文件链接。

FileInfo

文件信息的数据结构：
名称
类型
是否必填
说明
FileName
String
是
文件名称。
FileSize
String
是
文件大小。
FileUrl
String
是
文件 URL。
注意：
请使用上传到ADP的文件链接（参考离线文档上传），或者可以公开访问的文件链接。
FileType
String
是
文件类型。
DocId
String
否
实时文档解析接口返回的 doc_id。
注意：
在使用标准模式的文件对话时，这个字段必填。

Widget

Widget 信息
名称
类型
是否必填
说明
WidgetId
String
是
Widget 配置 ID。
WidgetRunId
String
是
Widget 实例 ID。
State
String
是
Widget 状态数据，用于兜底显示。
Position
Number
否
Widget 位置。
View
String
是
JSON 格式的 Widget 信息。
注意：
Widget 信息的渲染可以使用腾讯基于 Web Components 标准开发的跨框架 UI 组件 SDK。
SDK 说明文档：ADP-Widget SDK

WidgetAction

Widget 动作信息的数据结构：
名称
类型
是否必填
说明
WidgetId
String
是
Widget 配置 ID。
WidgetRunId
String
是
Widget 实例 ID。
ActionType
String
是
Widget 动作。
Payload
String
是
Widget 动作提交的数据。

QuoteInfo

参考来源索引
名称
类型
是否必填
说明
Position
Number
是
参考来源位置。
Index
Number
是
参考来源索引顺序。

Reference

参考文献信息
名称
类型
是否必填
说明
Index
Number
是
引用来源索引 ID。
Type
Number
是
参考来源类型。
1：问答
2：文档片段
4：联网检索到的内容
5：知识图谱
Name
String
是
参考来源名称。
DocRefer
DocRefer
否
文档片段参考信息。
QaRefer
QaRefer
否
问答参考信息。
WebSearchRefer
否
联网检索内容参考信息。
GraphRAGRefer
否
知识图谱参考信息。

GraphRAGRefer

知识图谱参考信息
名称
类型
是否必填
说明
ReferenceId
String
是
知识图谱参考 ID，该字段对应 DescribeRefer 中的 ReferBizIds 字段。
KnowledgeId
String
是
知识图谱所在知识库业务 ID。
KnowledgeName
String
否
知识图谱所在知识库名称。

DocRefer

文档片段参考信息
名称
类型
是否必填
说明
ReferenceId
String
是
文档片段参考 ID，该字段对应 DescribeRefer 中的ReferBizIds 字段。
DocId
String
是
文档业务 ID。
DocName
String
是
文档名称。
KnowledgeId
String
是
文档所在知识库业务 ID。
KnowledgeName
String
否
文档所在知识库名称。
Url
String
是
文档访问地址。

QaRefer

问答参考信息
名称
类型
是否必填
说明
ReferenceId
String
是
文档片段参考 ID，该字段对应 DescribeRefer 中的 ReferBizIds 字段。
QaId
String
是
问答业务 ID。
KnowledgeId
String
是
问答所在知识库业务 ID。
KnowledgeName
String
否
问答所在知识库名称。

WebSearchRefer

联网检索内容参考信息
名称
类型
是否必填
说明
Url
String
是
网页 URL。

Sandbox

沙盒信息内容
名称
类型
是否必填
说明
Url
String
否
沙盒的 URL 地址。
DisplayUrl
String
否
沙盒通过浏览器打开的 URL 地址。
Content
String
否
沙盒的输出内容。

WebSearch

网页搜索内容
名称
类型
是否必填
说明
Content
String
是
网页搜索结果，json 格式的 string。

FileCollection

文件收集信息
名称
类型
是否必填
说明
MaxFileCount
Number
是
最大上传文件的数量。
SupportedFileTypes
Array of String
是
支持的上传文件类型。

Record

消息记录信息
名称
类型
是否必填
说明
Role
String
是
角色类型。
user：代表该条消息内容是用户发送的。
assistant：代表该条消息内容是智能体发送的。
RecordId
String
是
当前记录的 ID。
RelatedRecordId
String
否
关联记录的 ID。
ConversationId
String
是
会话的唯一标识符。
Status
String
是
当前状态，如 "processing"。
StatusDesc
String
是
状态描述。
Messages
Array of Message
否
消息列表，包含多个消息对象。
Procedures
Array of Procedure
否
处理过程列表，包含多个过程对象。
StatInfo
StatInfo
否
统计信息。
ExtraInfo
否
扩展信息。

RecordExtraInfo

消息记录扩展信息
名称
类型
是否必填
说明
RequestId
String
是
请求 ID，用于标识一个请求（作消息串联，建议每个请求使用不同的 RequestId）。
TraceId
String
是
链路 ID。
Elapsed
Number
是
事件耗时, 单位 ms。
StartTime
Number
是
事件开始时间，单位ms。
IsFromSelf
Boolean
是
消息是否由客户端发出。
IsLlmGenerated
Boolean
否
是否为模型生成内容。
CanRating
Boolean
否
该消息记录是否能评价。
CanFeedback
Boolean
否
该消息记录是否能反馈。
注意：
此字段可能返回 null，表示取不到有效值。示例值：false
ReplyMethod
Number
否
回复方式：
1：大模型回复
2：未知问题回复
3：拒答问题回复
4：敏感回复
5：已采纳问答对优先回复
6：欢迎语回复
7：并发数超限回复
8：全局干预知识
9：任务流回复
10：任务流答案
11：搜索引擎回复
12：知识润色后回复
13：图片理解回复
14：实时文档回复
15：澄清确认回复
16：工作流回复
17：工作流运行结束
18：智能体回复
19：多意图回复

Message

消息详情
名称
类型
是否必填
说明
Type
String
是
消息类型。
reply：回复消息
thought：思考消息
tool_call：工具调用消息
task_execution：任务执行消息
recommendation：推荐问消息
notice：中间提示消息
MessageId
String
是
消息的唯一标识。
Name
String
是
消息名称。
Title
String
是
消息标题。
Icon
String
否
图标 URL。
Status
String
是
消息状态，如 "success"。
StatusDesc
String
否
状态描述，如 "思考完成"。
Contents
Array of Content
否
内容数组，包含多个内容对象。
ExtraInfo
否
扩展信息。

MessageExtraInfo

消息额外信息
名称
类型
是否必填
说明
Elapsed
Number
是
消息持续时间。
StartTime
Number
是
消息开始时间。
AgentName
String
否
输出消息的智能体名称。
AgentIcon
String
否
输出消息的智能体图标。
ParentMessageId
String
否
父消息 ID。

Procedure

处理过程详情
名称
类型
是否必填
说明
Name
String
是
过程名称。
Title
String
是
过程标题。
Status
String
是
过程状态，如 "success"。
IntentCate
String
否
意图分类。
ResourceStatus
Number
否
计费资源状态。
1：可用
2：不可用
Type
String
是
过程类型，如 "agent"。
Knowledge
Knowledge
否
知识库执行详情。
Workflow
否
工作流执行详情。
Agent
Agent
否
智能体执行详情。
StatInfos
Array of StatInfo
否
模型统计。

Knowledge

知识库执行详情
名称
类型
是否必填
说明
Content
String
是
检索 Query。
System
String
否
系统 Prompt。
RewriteQuery
String
否
改写后 Query。
CustomVariables
Array of String
否
自定义参数。
Histories
Array of History
否
多轮历史信息。
Outputs
Array of KnowledgeOutput
否
知识库检索输出。

History

历史信息
名称
类型
是否必填
说明
Assistant
String
否
智能体输出。
User
String
否
用户输入。

KnowledgeOutput

知识库检索输出信息
名称
类型
是否必填
说明
Type
Number
是
数据类型。
1：问答
2：文档片段
Content
String
是
知识内容。

WorkflowProcedure

工作流调用详情
名称
类型
是否必填
说明
WorkflowId
String
是
工作流 ID。
WorkflowName
String
是
工作流名称。
WorkflowReleaseTime
String
是
工作流发布时间，Unix时间戳。
WorkflowRunId
String
是
工作流运行 ID。
Content
String
是
工作流输入信息。
Outputs
Array of String
是
多气泡的输出结果。
OptionCardIndex
否
选项卡索引。
OptionCards
Array of String
否
选项卡。
RunNodes
Array of RunNode
是
工作流节点信息。

OptionCardIndex

选项卡索引信息
名称
类型
是否必填
说明
RecordId
String
是
消息唯一标识。
Index
Number
是
选项卡索引。

RunNode

工作流节点信息
名称
类型
是否必填
说明
Elapsed
String
是
节点调用耗时。
NodeId
String
是
节点 ID。
NodeName
String
是
节点名称。
NodeType
Number
是
节点类型。
Status
Number
是
节点执行状态。
Input
String
否
节点输入。
InputRef
String
否
节点输入的完整内容的链接。
Output
String
否
节点输出。
OutputRef
String
否
节点输出的完整内容的链接。
TaskOutput
String
否
任务输出。
TaskOutputRef
String
否
任务原始输出的完整内容的链接。
Reply
String
否
当前节点的回复内容。
FailCode
String
否
异常信息对应的错误码。
FailMessage
String
否
异常信息。
BelongNodeId
String
否
节点所属工作流被引用时的引用节点的ID。
IsCurrent
Boolean
否
当前走过的节点。
StatInfos
Array of StatInfo
否
大模型统计信息。

Agent

智能体执行详情
名称
类型
是否必填
说明
Input
String
否
工具、大模型的输入信息，json 格式。
Output
String
否
工具、大模型的输出信息，json 格式。
ModelName
String
否
模型名。
Content
String
是
检索 Query。
System
String
否
系统 Prompt。
RewriteQuery
String
否
改写后 Query。
CustomVariables
Array of String
否
自定义参数。

StatInfo

统计信息
名称
类型
是否必填
说明
Elapsed
Number
否
响应耗时。
StartTime
Number
否
响应开始时间。
InputTokens
Number
否
输入 token 总数。
OutputTokens
Number
否
输出 token 总数。
TotalTokens
Number
否
总 token 数。
ModelName
String
否
使用模型名。
FirstTokenCost
Number
否
模型首 token 耗时。
TotalCost
Number
否
模型总耗时。

Error

错误信息
名称
类型
是否必填
说明
Code
Number
是
错误码。
Message
String
是
错误消息。
RequestId
String
是
错误关联的 RequestId。
TraceId
String
是
错误的 TraceId。
Elapsed
Number
否
请求耗时（毫秒）。
StartTime
Number
否
请求开始时间（毫秒级时间戳）。

Rating

点赞/点踩信息
名称
类型
是否必填
说明
RequestId
String
是
请求 ID，用于标识一个请求（用作消息串联，建议每个请求使用不同的 request_id）。
RecordId
String
是
消息 ID。
Score
String
是
评分：
1：点赞
2：点踩
3：取消点赞
4：取消点踩
Reasons
Array of String
否
所选原因（用户反馈的内容，可以有多个）
TraceId
String
否
消息的 TraceId。
FeedbackContent
String
否
用户反馈内容。

StopGeneration

停止生成信息
名称
类型
是否必填
说明
RequestId
String
是
请求 ID，用于标识一个请求（用作消息串联，建议每个请求使用不同的 request_id）。
RecordId
String
是
需要停止生成的消息 ID。

Reconnect

重连信息
名称
类型
是否必填
说明
RequestId
String
是
请求 ID，用于标识一个请求（用作消息串联，建议每个请求使用不同的 request_id）。
RecordId
String
是
需要重连继续接收的消息 ID。

5. 错误码

错误码
错误信息
400
请求参数错误, 请参阅接入文档。
460001
Token 校验失败。
460002
事件处理器不存在。
460004
应用不存在。
460006
消息不存在或没有操作权限。
460007
会话创建失败。
460008
Prompt 渲染失败。
460009
访客用户不存在。
460010
会话不存在或没有操作权限。
460011
超出并发数限制。
460020
模型请求超时。
460021
知识库未发布。
460022
访客创建失败。
460023
消息点赞点踩失败。
460024
标签不合法。
460025
图像识别失败。
460031
当前应用连接数超出请求限制，请稍后再试。
460032
当前应用模型余额不足。
460033
应用不存在或没有操作权限。
460034
输入内容过长。
460035
计算内容过长, 已经停止。
460036
任务流程节点预览参数异常。
460037
搜索资源已用尽，调用失败。
460038
该 AppID 请求存在异常行为，调用失败。
4505004
APPKEY 无效，请核实 APPKEY 来源对应发送事件。



中国站
目录