智能体 Web SDK （AI 助教专版）使用指南

初始化示例

提示

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

<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>

初始化参数

注意

• 因历史原因，初始化参数中的 unitId 可以使用 belongschoolid 代替（该写法仅允许存在 courseId 时使用），二者含义相同，推荐使用 unitId。

字段	类型	是否必填	默认值	说明
appId	string	✅		智能体开放平台应用 ID 鉴权说明
appAuthToken	string	✅		SDK 接入 token 鉴权说明
origin	string	✅		数据源地址 查看选项
unitId	string	✅		单位 ID
courseId	string	✅		课程 ID
scene	string	✅		场景 固定为 course
rootClass	string			自定义容器 css 类名
locale	string		zh-CN	多语言设置 查看选项
useBuiltInNotify	number		1	是否使用内置通知消息 查看选项
openType	string		inset	展开方式 查看选项
openPage	string		""	打开页面 查看选项
useToonFigure	number		0	启用卡通交互形象 查看选项
toonPreset	string		normal	卡通交互形象预置 查看选项
allowOpenChatWin	number		1	是否允许点击打开聊天框 查看选项
autoOpen	number		0	自动打开聊天窗口 查看选项
showTalkContent	number		0	朗读时是否将朗读内容作为消息展示 查看选项
asr	number		0	是否启用语音识别 (仅在 useToonFigure = 1 时生效) 查看选项
speak	number		0	是否启用语音输出 (仅在 useToonFigure = 1 时生效) 查看选项
wakeword	string		""	主唤醒词 (仅在 asr = 1 时生效)
wakewordAuxs	string		""	辅助唤醒词， 多个请使用英文逗号分隔
wakeResponse	string		""	唤醒响应内容，若配置该参数将在唤醒后自动朗读该参数内容
discoverHost	string		""	嵌入式发现页自定义主机名。 查看说明
${key}	any			业务参数，可以是任意字段名称。如果值包含非 ASCII 内容请使用 URIComponent 进行编码

参数选项列表

origin

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

• 测试环境：https://robot-lc1.chaoxing.com

• 灰度环境：https://robot-lc2.chaoxing.com

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

locale

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

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

openType

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

• inset：嵌入式，即在当前页面展开
• openUrl：新页面打开

openPage

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

• digital：数字人页面

useBuiltInNotify

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

• 1：使用
• 0：不使用

useToonFigure

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

• 0：不使用
• 1：使用

toonPreset

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

• normal：小星
• star：小星星

allowOpenChatWin

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

• 0：不允许
• 1：允许

autoOpen

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

• 0：不打开
• 1：打开

showTalkContent

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

• 0：不使用
• 1：使用

speak

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

• 1：启用
• 0：不启用

asr

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

• 1：启用
• 0：不启用

discoverHost

嵌入式发现页自定义主机名。

该字段的值是符合标准主机名格式的字符串（从 URL 中剔除协议、路径、查询字符串和文档片段后的剩余部分），允许保留端口号