智能体 Web SDK（通用版） 使用指南

初始化示例

提示

以下示例中的参数仅供展示，实际使用时请替换为您的参数。

<script>
  const options = {
    appId: "your_app_id",
    appAuthToken: "your_app_auth_token",
    unitId: 1234,
    robotId: "",
    groupId: "",
    accessToken: "",
    scene: "",
  };
  CxRobotSdkJs.init(options).then((robot) => {
    console.log(robot);
  });
</script>

初始化参数

提示

accessToken 参数属于敏感字段，请联系智能体开发团队获取。

字段	类型	是否必填	默认值	说明
appId	string	✅		智能体开放平台应用 ID 鉴权说明
appAuthToken	string	✅		SDK 接入 token 鉴权说明
origin	string	✅		数据源地址 查看选项
unitId	string	✅		单位 ID
robotId	string	✅		智能体 ID
accessToken	string	✅		智能体 ID 匹配的 token
locale	string		zh-CN	多语言设置 查看选项
element	string / HTMLElement			指定形象渲染位置，如需自定义样式请配合rootClass选项；为空时插入到页面顶层
rootClass	string			向根元素添加类名，用于自定义样式覆盖，如需指定形象初始化位置请配置element选项
groupId	string			人工服务分组 ID
visitorId	string			访客 ID
openType	string		inset	展开方式 查看选项
openPage	string		""	打开页面 查看选项
scene	string			场景 查看选项
useBuiltInNotify	number		1	是否使用内置通知消息 查看选项
useToonFigure	number		0	启用卡通交互形象 查看选项
useCustomFigure	function			使用自定义形象 查看选项
toonPreset	string		normal	卡通交互形象预置
toonRenderer	string		svg	卡通交互形象渲染器 查看选项
webToonPreset	string			展开页面的卡通交互形象预置
allowOpenChatWin	number		1	是否允许点击打开聊天框 查看选项
autoOpen	number		0	自动打开聊天窗口 查看选项
showTalkContent	number		0	朗读时是否将朗读内容作为消息展示 查看选项
folding	number		1	允许手动收起形象 查看选项
hiddenFigure	number		0	初始化时是否隐藏（收起）形象 查看选项
closeOnClickSideModal	number		0	侧拉展示时是否允许点击侧拉弹窗外部区域关闭 查看选项
asr	number		0	是否启用语音识别 (仅在 useToonFigure = 1 时生效) 查看选项
speak	number		0	是否启用语音输出 (仅在 useToonFigure = 1 时生效) 查看选项
wakeword	string		""	主唤醒词 (仅在 asr = 1 时生效)
wakewordAuxs	string		""	辅助唤醒词， 多个请使用英文逗号分隔
wakeResponse	string		""	唤醒响应内容，若配置该参数将在唤醒后自动朗读该参数内容
${key}	any			业务参数，可以是任意字段名称。如果值包含非 ASCII 内容请使用 URIComponent 进行编码

参数选项列表

origin

数据源地址代表了智能体的数据来源，请根据不同的环境选择不同的地址。

• 开发环境：https://robot-dev.chaoxing.com

• 测试环境：https://robot1.chaoxing.com

• 生产环境：https://robot.chaoxing.com

locale

多语言设置，可选值：zh-CN、en-US

• zh-CN：简体中文
• en-US：英文-美国

openType

展开方式，可选值：auto、inset、openUrl、side

• auto：自动，移动端自动设置为 openUrl，PC 端自动设置为 side
• inset：嵌入式，即在当前页面展开
• openUrl：新页面打开（新开页面将自动识别移动或 PC 设备）
• side：侧边栏

提醒

使用 openUrl 方式时，如果在学习通移动端希望以新的层级打开页面，请确保宿主页已引入学习通的 jsbridge，否则将在当前页面打开。

<script src="https://learn.chaoxing.com/res/js/cxjsbridge/CXJSBridge.2.0.js"></script>

openPage

指定点击形象时打开的页面，可选值： digital、coze

• digital：数字人页面
• coze：新版页面

注意

openPage 与 openType 组合规则见下表

• 表中不存在的组合表示该组合无效，将自动降级为DEFAULT组合

-	digital	coze	DEFAULT
inset	不存在	不存在	基础页面
openUrl	数字人页面	新版页面	基础页面
side	数字人移动页面	新版移动页面	基础移动页面

scene

场景，可选值：course

• course：课程场景

useBuiltInNotify

是否使用内置通知消息，可选值：1、0

• 1：使用
• 0：不使用

useToonFigure

是否启用卡通交互形象，可选值：0、1

• 0：不使用
• 1：使用

useCustomFigure

自定义形象函数，返回一个对象或Promise对象，对象包含以下字段：

• url：形象地址
• width：形象宽度
• height：形象高度
• right：形象距离右侧距离（视口距离，支持 css 单位）
• bottom：形象距离底部距离（视口距离，支持 css 单位）

注意

该参数不可以与 useToonFigure = 1 同时使用

示例：

{
  // ...其他参数
  useCustomFigure() {
   return {
     url: "https://picsum.photos/100/100",
     width: 100,
     height: 100,
     right: 50,
     bottom: 0,
   };
 }
 // ...其他参数
}

toonPreset

卡通交互形象预置，可选值：normal、star

• normal：基础形象
• star：小星

toonRenderer

提醒

当使用默认svg渲染器出现异常时可以尝试使用canvas渲染器；该参数仅在 useToonFigure = 1 时生效

卡通交互形象渲染器，可选值：svg、canvas

• svg: svg 渲染器
• canvas: canvas 渲染器

allowOpenChatWin

是否允许点击打开聊天框，可选值：1、0

• 1：允许
• 0：不允许

autoOpen

自动打开聊天窗口，可选值：1、0

• 1：打开
• 0：不打开

showTalkContent

朗读时是否将朗读内容作为消息展示，可选值：1、0

• 1：使用
• 0：不使用

folding

初始化时是否手动收起形象，可选值：1、0

• 1：允许收起形象
• 0：禁止收起形象

hiddenFigure

初始化时是否隐藏（收起）形象，可选值：1、0

• 1：隐藏形象
• 0：不隐藏形象

closeOnClickSideModal

侧拉展示时点击侧拉弹窗意外的区域是否关闭侧拉弹窗，可选值：1、0，默认值为 1

• 1：关闭弹窗
• 0：不关闭弹窗

speak

是否启用语音输出，可选值：1、0

• 1：启用
• 0：不启用

asr

是否启用语音识别，可选值：1、0

• 1：启用
• 0：不启用