Skip to content

Commit e9434bb

Browse files
doc: update
1 parent 8add6a2 commit e9434bb

8 files changed

Lines changed: 42 additions & 0 deletions

docs/dataease_integration.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
!!! Tip ""
2+
SQLBot v1.1.3 及以上版本支持配置接入到 DataEase 中,为 DataEase 提供智能问数功能。
3+
4+
## SQLBot 侧配置
5+
6+
### 新建高级应用
7+
!!! Tip ""
8+
SQLBot 需要以嵌入式应用方式接入到 DataEase 中,所以需要先在 SQLBot 平台中先创建一个高级应用,如下图所示:
9+
![示例](img/dataease/dataease_sqlbot_app.png)
10+
11+
设置基础信息。
12+
13+
这里注意,跨域设置为 DataEase 服务的访问地址,例如 https://demo.dataease.cn
14+
![示例](img/dataease/dataease_sqlbot_basic_info.png)
15+
16+
进行接口配置。
17+
18+
接口 URL 为 DataEase 服务的访问地址加上固定的 API 接口路径“de2api/sqlbot/datasource”,例如 https://demo.dataease.cn/de2api/sqlbot/datasource。
19+
20+
添加调用所需的接口凭证,以下配置对于 DataEase 对接来说都是固定的:
21+
22+
- 凭证名称: user.token
23+
- 源系统凭证类型: localStorage
24+
- 目标凭证名称: x-de-token
25+
- 目标凭证位置: header
26+
- 目标凭证: JSON.parse(`${source_val}`)['v'].replace(/^['\"]|['\"]$/g, '')
27+
28+
![示例](img/dataease/dataease_sqlbot_interface_info.png)
29+
30+
保存好应用,记录好应用的 ID 号。
31+
![示例](img/dataease/dataease_sqlbot_copy_id.png)
32+
33+
## DataEase 侧配置
34+
!!! Tip ""
35+
以 admin 用户登录 DataEase,在「系统设置」>「系统参数」>「第三方嵌入」中,对 SQLBot 的接入项进行设置。
36+
37+
输入 SQLBot 服务器 URL和前面步骤获取到的 SQLBot 高级应用的 ID 号,校验通过后保存即可。
38+
![示例](img/dataease/dataease_settings.png)
39+
40+
返回工作台后,即可在 DataEase 右上角的快捷工具栏看到 SQLBot。
41+
![示例](img/dataease/dataease_sqlbot.png)
114 KB
Loading
187 KB
Loading
118 KB
Loading
90.9 KB
Loading
71.4 KB
Loading
128 KB
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ nav:
7676
- 模型接入:
7777
- Ollama 部署模型接入 SQLBot: model_integration/ollama.md
7878
- MCP 服务: mcp_server.md
79+
- DataEase 接入: dataease_integration.md
7980
- 联系我们: contact.md
8081

8182
markdown_extensions:

0 commit comments

Comments
 (0)