智能体接入指引

Appearance

智能体 Web SDK （通用版）方法说明 ​

静态方法 ​

init ​

方法签名

js
init(options: object) => Promise<instance>

示例代码

提示

options 参数是初始化智能体实例的选项，详细说明见 概览-初始化参数 章节。

js
const options = {
  // ...
};
CxRobotSdkJs.init(options).then((robot) => {
  console.log(robot);
});

注意

考虑到存在大量 2023.10.1 前使用旧版 SDK 创建的应用。 init 方法同时兼容一种将所有参数序列化为地址参数的写法。 以下写法仅供旧版参考，不推荐使用，且可能在未来彻底删除废弃。

方法签名 即将废弃

js
init(url: string, accessToken: string, visiterId?: string) => Promise<instance>

示例代码 即将废弃

js
CxRobotSdkJs.init(
  "https://robot1.chaoxing.com/embedChat?unitId=1385&robotId=n6k13h8jo8lfjiyf4dxy9t7s6gppie30&groupId=0",
  "cb7d782fee38d4a1a193cedf17d66580"
);

实例方法 ​

setLocale ​

设置语言，查看可选值

方法签名

js
setLocale(locale: string) => void

setTranslate ​

设置形象（窗口）位置；基于原始位置的坐标偏移量，可以通过 robot.translate 获取用户拖放后的偏移信息。

方法签名

js
setTranslate(x: number, y: number) => void

示例代码

js
robot.setLocale("zh-CN");

on ​

注册一个事件监听

方法签名

js
on(event:string, callback:function) => void

示例代码

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

once ​

监听事件(仅触发一次)

方法签名

js
once(event:string, callback:function) => void

示例代码

js
robot.once("progress", (data) => {
  // 以下代码只会打印一次
  console.log(data);
});

off ​

取消指定事件的监听回调，callback 为空时取消所有同名事件

方法签名

js
off(eventName: string, callback?: function) => void

示例代码

js
const foo = () => {
  // to do something
};
const bar = () => {
  // to do something
};

// 监听 progress 事件
robot.on("progress", foo);
robot.on("progress", bar);

// 取消 progress 事件的 foo 回调，保留 bar 回调
robot.off("progress", foo);

// 取消所有 progress 事件的回调
robot.off("progress");

emit ​

触发事件，data 为可选参数

方法签名

js
emit(eventName: string, ...data?: any) => void

示例代码

js
// 监听 hello 事件
robot.on("hello", (...data) => {
  console.log(...data);
});

// 触发 hello 事件并传递参数
robot.emit("hello", "world");

// 触发 hello 事件并传递多个参数
robot.emit("hello", "world", "!");

// 触发 hello 事件并传递对象参数
robot.emit("hello", { name: "world" });

notify ​

展示一条通知消息

提示

调用该方法前请确保已触发 initSuccess 事件

方法签名

js
notify(message:string)

示例代码

js
robot.notify("你好，我是小星");

stopNotify ​

关闭通知

提示

调用该方法前请确保已调用过 notify 方法

方法签名

js
stopNotify() => void;

示例代码

js
robot.stopNotify();

talk ​

朗读指定文本

提示

仅在 options.useToonFigure 为 1 时可用

方法签名

js
talk(text: string) => void

示例代码

js
robot.talk("你好，我是小星, 有什么我能帮你的？");

hide ​

隐藏入口形象

方法签名

js
hide() => void

示例代码

js
robot.hide();

show ​

展示入口形象

方法签名

js
show() => void

示例代码

js
robot.show();

openWin ​

打开聊天窗口

方法签名

js
openWin() => void

示例代码

js
robot.openWin();

closeWin ​

关闭聊天窗口

方法签名

js
closeWin() => void

示例代码

js
robot.closeWin();

invoke ​

调用智能体页面能力，查看智能体页面能力

提示

调用该方法前请确保已触发 wsConnected 事件

方法签名

js
invoke(name: string, data?: any) => void

示例代码

js
robot.invoke("send", { text: "hello" });

destroy ​

销毁实例

提示

  1. 请在页面卸载时调用该方法，防止内存泄漏
  2. 销毁实例后，无法再使用该实例，请重新创建实例

方法签名

js
destroy() => void

示例代码

js
robot.destroy();