智能体 Web SDK （通用版）事件说明

initSuccess

智能体初始化成功

示例代码

robot.on("initSuccess", (target, options) => {
  console.log("initSuccess", target, options);
});

localeChange

智能体多语言切换， 提供当前使用的新语言

示例代码

robot.on("localeChange", (locale) => {
  console.log("localeChange", locale);
});

winVisibleChange

智能体聊天窗口可见性变化

示例代码

robot.on("winVisibleChange", (visible) => {
  console.log("winVisibleChange", visible);
});

figureVisibleChange

智能体入口形象可见性变化

示例代码

robot.on("figureVisibleChange", (visible) => {
  console.log("figureVisibleChange", visible);
});

progress

智能体聊天窗口加载进度

示例代码

robot.on("progress", (progress) => {
  console.log("progress", progress);
});

wsConnected

聊天链接已建立

示例代码

robot.on("wsConnected", () => {
  console.log("wsConnected");
});

wsDisconnected

聊天链接已断开

示例代码

robot.on("wsDisconnected", () => {
  console.log("wsDisconnected");
});

ask

向智能体发送消息时触发

注意

出于数据安全考虑，ask 事件需要配置域名白名单。请在监听该事件前确保已向智能体开发团队提交您的调用域名。

内置调试域名：localhost

示例代码

robot.on("ask", (data) => {
  console.log("Ask info", data);
});

message

智能体收到消息时触发，用于接收服务端发送的聊天消息

注意

出于数据安全考虑，message 事件需要配置域名白名单。请在监听该事件前确保已向智能体开发团队提交您的调用域名。

内置调试域名：localhost

示例代码

robot.on("message", (message) => {
  console.log("message", message);
});

消息类型说明

消息类型字段为 messageType，取值如下：

类型	说明
TEXT	文本消息(包含纯文本与富文本)
MENU	菜单消息
IMAGE	图片消息
AUDIO	音频消息
FILE	文件消息
JOUR_LIST	期刊列表
DELIVERY	文献传递(期刊详情)
BOOK_LIST	图书列表
MACHINE_READ	大模型回复
MACHINE_READ_LOADING	大模型回复（等待）
MACHINE_READ_IN_CHAT	大模型回复（上一次回答未完成）
THESIS_LIST	论文列表
GUESS_HOT	猜你想问
DELIVERY_NEW	文献传递(PDF 文件形式返回)
RADIO_CONFIRM	单选（含提交按钮）
RADIO_PICKER	单选（不含提交按钮）

talkStart

语音播放时触发

提示

仅在启用卡通交互形象时可用

示例代码

robot.on("talkStart", (event) => {
  console.log("talkStart", event);
});

talkEnd

语音播放结束时触发

提示

仅在启用卡通交互形象时可用

示例代码

robot.on("talkEnd", (event) => {
  console.log("talkEnd", event);
});

dragStart

拖拽移动入口智能体形象开始时触发

robot.on("dragStart", (data) => {
  const { x, y, dx, dy, width, height, target } = data;
  console.log("dragStart", data);
});

drag

拖拽移动入口智能体形象过程中触发

提示

该事件未作防抖处理，请业务方自行实现

示例代码

robot.on("drag", (data) => {
  const { x, y, dx, dy, width, height, target } = data;
  console.log("drag", data);
});

dragEnd

拖拽移动入口智能体形象结束时触发

示例代码

robot.on("dragEnd", (data) => {
  const { x, y, dx, dy, width, height, target } = data;
  console.log("dragEnd", data);
});

wakeup

语音唤醒成功

提示

仅在启用卡通交互形象时可用

示例代码

robot.on("wakeup", () => {
  console.log("wakeup");
});

asrResult

ASR 语音识别成功

提示

仅在启用卡通交互形象时可用

示例代码

robot.on("asrResult", (result) => {
  console.log("asrResult", result);
});

asrError

ASR 语音识别触发异常

提示

仅在启用卡通交互形象时可用

示例代码

robot.on("asrError", (error) => {
  console.log("asrError", error);
});

destroy

智能体销毁时触发

示例代码

robot.on("destroy", () => {
  console.log("destroy");
});