SDK集成
创建机器人
前文已详细介绍了创建机器人的流程,包括三个功能选项卡。以下是第三个选项卡页面的内容。
授权知识空间
之前已介绍了知识库的成员授权内容,只有完成授权后,机器人才能正常回答问题。
复制代码
在"机器人管理"菜单下面,点击进入需要创建(或编辑)的机器人
在创建(或编辑)的机器人页面,点击“安装代码”->点击“点击复制”即可复制安装代码
引用SDK脚本
在需要的页面添加如下(上一步骤中复制的)代码
<script src="https://console.aid.daxue.cloud/AIDSDK.js"></script>
<script>
// 初始化小窗口
window.AIDO = new AID({
rid: '系统生成您的机器人ID',
AUID: '系统生成您的用户ID',
AUNM: '系统生成您的用户名',
env: 'development',
showHeader: true,
showFullscreen: true,
showVerticalFullScreen: false,
showClose: true,
robotSource: 'jssdk'
})
// 销毁
// window.AIDO.destroy()
</script>
初始化参数说明
// window.AIDO = new AID(options)
// options: {rid: 'xxx'}
键 | 描述 | 默认值 | 是否必填 |
---|---|---|---|
rid | 系统生成您的机器人ID | - | 是 |
AUID | 系统生成您的用户ID | - | 是 |
AUNM | 系统生成您的用户名 | - | 是 |
env | 环境 | prod [development,unitest,prod] | 否 |
offsetY | 展开按钮位置的垂直偏移量 | 0 | 否 |
defaultLanguage | 默认语言 | 根据客户端浏览器环境自动选择 [zh-CH,en-US] | 否 |
canChangeLanguage | 客户端是否可以自由切换语言 | 是 | 否 |
showHeader | 是否显示Header | false | 否 |
showFullscreen | 是否显示Header中的最大化按钮 | false | 否 |
showVerticalFullScreen | 是否显示Header中的纵向最大化按钮 | false | 否 |
showClose | 是否显示Header中的关闭按钮 | false | 否 |
domId | 如果想渲染到某个dom中,则为dom的id | - | 否(渲染到dom情况下必填) |
extInfo | 增加一些拓展信息 | '{"nickname":"xxx", xxx: "xxx"}' | 否 |
请注意:AUID可以填写“组织架构”下的“成员管理”中用户的手机号码、电子邮件地址,或者员工编号;系统生成的是用户 ID,该号码与其他三个值等同。 AUNM代表当前用户的姓名,但后续会移除该参数,请不要依赖该信息,当前仅显示于对话窗口左下角.
方法
// 销毁已经创建的AID插件
window.AIDO.destroy()
注意事项
AUID和AUNM的参数与知识内容的授权相关。若填写不正确,机器人将无法回答相应内容。