@glodon-aiot/bot-client-ui 3.3.3 → 3.3.4-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -17
- package/dist/es/index.mjs +1 -1
- package/dist/lib/index.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -39,23 +39,25 @@ new BotClientUI({
|
|
|
39
39
|
|
|
40
40
|
## 通用配置
|
|
41
41
|
|
|
42
|
-
| 名称
|
|
43
|
-
|
|
|
44
|
-
| token
|
|
45
|
-
| apiUrl
|
|
46
|
-
| getContainer
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
42
|
+
| 名称 | 类型 | 必填 | 默认值 | 说明 | 适用应用类型 | 支持版本 |
|
|
43
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
44
|
+
| token | string | 是 | - | aiot 行业AI平台的AI应用的resource token。详情查看[认证说明](https://glodon-cv-help.yuque.com/lzh2bp/eszzb5/evk1gvh3pqaexe74?singleDoc#%20《认证说明》)。 | 全部 | |
|
|
45
|
+
| apiUrl | string | 否 | `https://copilot.glodon.com/api/cvforce` | 拼接规则:``${origin}/api/cvforce``,其中`origin`是部署服务的源地址。 | 全部 | 3.0.8 |
|
|
46
|
+
| getContainer | () => Element | 否 | () => document.body | 容器元素获取方法,默认在document.body中渲染 | 全部 | |
|
|
47
|
+
| sessionId | string | 否 | - | 默认加载的会话ID | Agent/对话 | |
|
|
48
|
+
| mode | 'float' | 'inlay' | 否 | 'float' | 悬浮按钮模式,或者嵌入模式 | Agent/对话 | |
|
|
49
|
+
| header | Element | string | boolean | 否 | 应用名称 | 应用名称 | Agent/对话 | |
|
|
50
|
+
| footer | Element | string | boolean | 否 | | | Agent/对话 | |
|
|
51
|
+
| sider | boolean | 否 | | inlay模式可用。 是否展示左侧会话列表 | Agent/对话 | |
|
|
52
|
+
| icon | string | 否 | | 影响greeting和triggerButton的icon | Agent/对话 | 3.3.1 |
|
|
53
|
+
| size | [SizeConfig](#GbxmJ) | 否 | {width: 450} | float模式下:窗体大小 | 全部 | |
|
|
54
|
+
| open | boolean | 否 | false | float模式下:默认打开状态 | Agent/对话 | |
|
|
55
|
+
| triggerButton | [TriggerButtonConfig](#djhoc) | 否 | {visible: true} | triggerButton设置 | Agent/对话 | |
|
|
56
|
+
| features | [Features](#uIpxC) | 否 | FEATURE_DEFAULT | 功能配置 | Agent/对话 | |
|
|
57
|
+
| debug | boolean | 否 | false | 打开debug模式时:<br/>1. 控制log输出。 2. promptValues变为非必填项; 3. Agent类型应用下,控制ws连接是否开启,debug模式,由于收到权限限制,可能会配置失败。 | Agent/对话 | |
|
|
58
|
+
| eventListeners | [EventListeners](#IhvdK) | | | 事件监听器配置 | Agent/对话 | |
|
|
59
|
+
| errorHandlers | [ErrorHandlers](#VTONU) | 否 | - | errorHandlers.token 是token验证失败后的处理器; errorHandlers.promptValues 非debug模式下,检测空值 | 全部 | |
|
|
60
|
+
|
|
59
61
|
|
|
60
62
|
## 只适用于 Agent 应用的配置
|
|
61
63
|
|
|
@@ -197,6 +199,14 @@ interface Feature {
|
|
|
197
199
|
knowledges?: boolean | { visible: boolean; default: Knowledge[]; disabled?: boolean };
|
|
198
200
|
// 用户指令变量设置
|
|
199
201
|
promptVariables?: boolean | { visible: boolean; default: SessionPrompt[] };
|
|
202
|
+
// 支持自定义问答内容markdown的超链接元素的点击事件
|
|
203
|
+
markdown?: {
|
|
204
|
+
componentProps?: {
|
|
205
|
+
a?: {
|
|
206
|
+
onClick?: (e: {nativeEvent: PointerEvent}) => void;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
}
|
|
200
210
|
}
|
|
201
211
|
```
|
|
202
212
|
|