Skip to content

Commit 4b18c4a

Browse files
author
Ya yanpei
committed
Merge remote-tracking branch 'origin/v1' into v1
# Conflicts: # docs/user_manual/data_training.md
2 parents 1393734 + 8d66b10 commit 4b18c4a

9 files changed

Lines changed: 156 additions & 35 deletions

File tree

docs/buy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## 专业版
2+
3+
SQLBot 专业版包括 X-Pack 增强包和基础级的原厂企业级支持服务,提供不限制账号数量的软件授权,支持单机/冷备部署,价格为 3 万/套。
4+
5+
购买咨询:
6+
7+
![购买咨询](<img/index/Buy_QR_code.png>){ width="135px" }

docs/changelog.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,49 @@
1010

1111
## 2 更新内容
1212

13+
14+
### v1.2.0
15+
16+
2025 年 9 月 30 日
17+
18+
19+
!!! Tip "新增功能 :star2:"
20+
21+
- 数据源:新增数据源表关系管理功能,支持更好的数据关联分析。
22+
- 数据源:新增对 Kingbase 数据库的连接支持。
23+
- MCP:MCP 支持获取第三方系统数据源。
24+
- 自动滚动:对话窗口消息较多出现滚动条时,滚动条将自动滚动到底部。
25+
- 推理块解析:新增对 <think> 推理块的解析支持。
26+
- 自定义提示词(X-Pack):新增自定义提示词功能 。
27+
- 流式传输控制:MCP 助手和问答功能新增禁用流式传输的参数控制。
28+
- 术语设置:术语设置中新增数据源配置选项 (#127)。
29+
- 韩语更新:更新并完善韩语本地化内容。
30+
31+
32+
!!! Tip "功能优化 :sunflower:"
33+
34+
- 查询速度优化:显著提升数据查询的执行速度。
35+
- 精简 AES 字段:移除非必要的 AES IV 字段,提升系统性能。
36+
- 参数化控制:新增参数控制表数量功能。
37+
- 数据源连接优化:数据源连接现在支持额外配置参数。
38+
- 字段类型优化:优化数据源表字段类型处理。
39+
40+
41+
!!! Tip "问题修复 :palm_tree:"
42+
43+
- 助手名称:修复助手名称更改后,嵌入页面左上角未同步更新的问题。
44+
- 仪表板图标:修复仪表板中图标未垂直居中的显示问题。
45+
- 系统管理导航:修复点击 logo 默认跳转到用户管理的问题。
46+
- 左侧菜单:修复左侧菜单栏 logo 信息显示错误的问题。
47+
- MCP:修复 SQL 执行结果为空时 MCP 聊天运行错误的问题。
48+
- 为 TABLE_EMBEDDING_ENABLED 添加类型注解。
49+
- 修复 Docker 卷路径的错误。
50+
- 修复 Elasticsearch 连接的错误。
51+
- 修复 SQL Server 2012 连接的错误。
52+
53+
54+
55+
1356
### v1.1.1
1457

1558
2025 年 9 月 5 日

docs/embedding_integration.md

Lines changed: 58 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
!!! Abstract ""
2-
嵌入式对接分为三类,分别是:
32

4-
- 小助手-基础应用
5-
- 小助手-高级应用
6-
- 页面嵌入
7-
8-
其中小助手分为两小类,分别是:浮窗嵌入、全屏嵌入。
3+
SQLBot 支持通过【小助手嵌入】和【网页嵌入】的方式将智能问数能力嵌入到外部系统页面中。
4+
5+
6+
其中【小助手嵌入】包含【基础应用】和【高级应用】两种模式,每种模式都支持「浮窗嵌入」和「全屏嵌入」两种呈现方式。
97

108
嵌入式 Demo 地址:https://github.com/dataease/sqlbot-embedded-demo
119

@@ -17,9 +15,11 @@
1715
| 高级应用 | 宿主权限 | 宿主数据源(api 接口) | 有权限要求,有自己的权限体系 |
1816
| 页面嵌入 | SQLBot 权限 | SQLBot 数据源 | 有权限要求,无自己的权限体系 |
1917

20-
## 新建应用
18+
## 1 新建应用
2119

22-
### 小助手-基础应用
20+
### 1.1 小助手嵌入
21+
22+
#### 1.1.1 基础应用
2323

2424
!!! Abstract ""
2525
使用 admin 账号登录 SQLBot,切到系统设置菜单-嵌入式管理,新建对应的应用。
@@ -32,57 +32,86 @@
3232
![示例](../img/embedding/sqlbot_basic_datasource.png)
3333
小助手-基础应用有“游客/员工”简单权限模式,游客只能访问“公共”数据源
3434

35-
### 小助手-高级应用
35+
36+
#### 1.1.1 高级应用
3637

3738
!!! Abstract ""
3839
高级应用在新建环节和基础应用的区别就是数据源,通过 API 接口的方式获取。
3940
![示例](../img/embedding/sqlbot_advanced_info.png)
4041
![示例](../img/embedding/sqlbot_advanced_interface.png)
4142

42-
开启 AES 加密,那么宿主系统提供的 API 接口中需要对相应的字段进行 AES 加密。
43-
一般场景下宿主 API 接口会有认证机制,例如 token、cookie 等。这些凭证信息一般情况下会存储在前端页面,填写接口凭证,SQLBot 会在宿主页面上根据填写的凭证信息去获取凭证但不存储,获取的时机是在每次“问数”。SQLBot 根据获取到的凭证去调用宿主系统的 API 接口。有些基于 httpOnly 的 cookie 凭证,SQLBot 无法获取,可以为数据源接口额外定义一个认证凭证。
44-
![示例](../img/embedding/sqlbot_advanced_interface2.png)
43+
!!! Abstract ""
44+
45+
- AES 加密:当开启 AES 加密时,宿主系统提供的 API 接口需对相关字段进行 AES 加密处理。
46+
47+
- 接口认证
48+
- 在常见场景下,宿主 API 接口通常具备认证机制(如 Token、Cookie 等)。
49+
50+
- 这些认证凭证一般由前端页面存储,用户在 SQLBot 中填写接口凭证后,SQLBot 会在宿主页面上按需读取凭证并调用 API 接口,但 不会存储任何凭证信息。
51+
52+
- 凭证的读取发生在每次“问数”时,SQLBot 根据获取到的凭证调用宿主系统的 API 接口。
53+
54+
- httpOnly Cookie 场景:对于基于 httpOnly Cookie 的认证方式,由于 SQLBot 无法直接读取此类 Cookie,可以在数据源接口中额外定义一个认证凭证以实现访问。
4555

46-
注意:目标凭证字段(非必填)支持 js 表达式。
56+
![示例](../img/embedding/sqlbot_advanced_interface2.png)
4757

48-
以 Demo 系统为例:
58+
!!! Abstract ""
59+
60+
**注意**:目标凭证字段(非必填)支持 JS 表达式,可灵活处理凭证值。
61+
62+
Demo 系统示例:
4963
![示例](../img/embedding/sqlbot_advanced_demo.png)
5064

51-
分别解释接口凭证的字段
65+
以下分别说明接口凭证各字段的含义:
66+
67+
源系统凭证:
68+
69+
- 类型:localStorage
70+
71+
- 凭证名称:sqlbot-embedded-token
5272

53-
源系统凭证类型 localStorage,凭证名称 sqlbot-embedded-token。
73+
- 含义:从 localStorage 中读取 key 为 sqlbot-embedded-token 的值
5474

55-
解释:从 localStirage 中获取 key 为 sqlbot-embedded-token 的信息。代码
75+
- 示例代码
5676

5777
```
5878
var source_val = localStorage.getItem('sqlbot-embedded-token')
5979
```
6080

61-
目标凭证`Bearer ${JSON.parse(JSON.parse(source_val).v)}`。
81+
目标凭证
82+
83+
- 值: `Bearer ${JSON.parse(JSON.parse(source_val).v)}`。
84+
85+
- 含义:基于上一步获取的 source_val 进行解析并拼接成最终凭证。
86+
- 示例代码:
6287

63-
解释:根据上一步获取到的 source_val 进一步拼接凭证,代码:
6488
```
6589
source_val = `Bearer ${JSON.parse(JSON.parse(source_val).v)}`
6690
```
6791

68-
目标凭证位置 header,名称 sqlbot-embedded-token。
92+
目标凭证位置
93+
94+
- 位置:header
95+
96+
- 名称:sqlbot-embedded-token
97+
98+
- 含义:将拼接好的凭证放在请求头中,以 sqlbot-embedded-token 作为 Header 名称调用 API。
6999

70-
解释:把上一部获取到的凭证放在请求头的 sqlbot-embedded-token 中去调 API。
71100

72-
### 页面嵌入
101+
### 1.2 页面嵌入
73102

74103
!!! Abstract ""
75-
填写名称、跨域设置
104+
填写名称、跨域设置
76105
![示例](../img/embedding/sqlbot_page.png)
77106

78107
记录 APP ID 以及 APP Secret,后面编码环节用得到。
79108

80-
## 宿主系统实现
109+
## 2 宿主系统实现
81110

82111
!!! Abstract ""
83112
下载 Demo 代码 https://github.com/dataease/sqlbot-embedded-demo
84113

85-
配置数据库信息
114+
配置数据库信息
86115

87116
![示例](../img/embedding/project_config.png)
88117

@@ -104,7 +133,7 @@
104133

105134
代码层面基础应用和高级应用嵌入方式基本没有区别。
106135

107-
### 浮窗模式
136+
### 2.1 浮窗模式
108137

109138
!!! Abstract ""
110139
参考 assistan/float.vue 文件
@@ -123,7 +152,7 @@
123152
如接入成功,访问小助手浮窗宿主页面,右下角会出现浮动图标,如下图:
124153
![示例](../img/embedding/project_float_demo.png)
125154

126-
### 全屏模式
155+
### 2.2 全屏模式
127156

128157
!!! Abstract ""
129158
参考 assistant/full.vue 文件
@@ -136,7 +165,7 @@
136165

137166
![示例](../img/embedding/project_fullscreen_demo.png)
138167

139-
### 页面嵌入
168+
### 2.3 页面嵌入
140169

141170
!!! Abstract ""
142171
参考 embedded/index.vue 文件
@@ -153,7 +182,7 @@
153182

154183
![示例](../img/embedding/project_page_demo2.png)
155184

156-
### 高级应用 API 接口
185+
### 2.4 高级应用 API 接口
157186

158187
!!! Abstract ""
159188
接口基本信息

docs/faq/smart_question_description.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@
88
## 2 术语怎么使用?
99

1010
!!! Abstract ""
11-
当用户发起问数请求时,会根据发送的问题匹配术语,被匹配到的术语,会将「术语描述」和「用户问题」一起发送给大语言模型,辅助生成正确的 SQL 查询语句。
11+
当用户发起问数请求时,会根据发送的问题匹配术语,被匹配到的术语,会将「术语描述」和「用户问题」一起发送给大语言模型,辅助生成正确的 SQL 查询语句。
1212

13-
术语示例如下图所示:
13+
术语示例如下图所示:
1414

1515
![professional..png](../img/faq/professional..png)
1616

1717
## 3 SQL 示例怎么使用?
1818

1919
!!! Abstract ""
20-
当用户发起问数请求时,将发送的问题与 SQL 示例库中的问题进行匹配,被匹配到的 SQL 示例,会将问题的「 示例 SQL」和「用户问题」一起发送给大语言模型,辅助生成正确的 SQL 查询语句。
20+
当用户发起问数请求时,将发送的问题与 SQL 示例库中的问题进行匹配,被匹配到的 SQL 示例,会将问题的「 示例 SQL」和「用户问题」一起发送给大语言模型,辅助生成正确的 SQL 查询语句。
2121

22-
SQL 示例如下图所示:
22+
SQL 示例如下图所示:
2323

2424
![data_training.png](../img/faq/data_training.png)
2525

docs/img/index/Buy_QR_code.png

18.3 KB
Loading
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 云市场部署指南
2+
3+
!!! Abstract ""
4+
5+
本指南将介绍如何通过阿里云云市场购买、部署和使用 **SQLBot** 镜像,并提供购买服务器的优惠链接。
6+
7+
## 1 购买镜像
8+
9+
!!! Abstract ""
10+
11+
- SQLBot 已经上架到阿里云云市场,您可以通过以下链接直接购买镜像:
12+
[SQLBot 云市场购买链接](https://market.aliyun.com/detail/cmjj00071938.html?userCode=kmemb8jp)
13+
14+
- 您也可以自行购买阿里云服务器,并在选择镜像时搜索 **SQLBot**,即可快速选择镜像进行部署。
15+
16+
**注意:** 购买时请选择合适的实例规格,建议 4C/8G 及以上。
17+
18+
## 2 启动服务
19+
20+
!!! Abstract ""
21+
22+
镜像启动后,您可以通过浏览器访问以下地址登录 SQLBot:
23+
24+
```
25+
服务访问地址: http://服务器IP:8000
26+
默认用户名: admin
27+
默认密码: SQLBot@123456
28+
```
29+
30+
首次登录后,建议及时更改密码并进行其他安全设置。
31+
32+
## 3 开放端口
33+
34+
!!! Abstract ""
35+
36+
- 为了确保外部能够正常访问 SQLBot 服务,您需要在阿里云服务器的安全组规则中开放 `8000` 端口。
37+
38+
- 具体的开放步骤可以参考阿里云的 [端口放行教程](https://help.aliyun.com/document_detail/25471.html)。

docs/user_manual/data_training.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
!!! Tip ""
1313
进入【SQL 示例库】页面:在系统导航栏点击【设置】>【SQL 示例库】。
1414
![data_trainning.png](../img/user_manual/setting/data_trainning.png)
15+
1516
!!! Tip ""
1617
点击【添加示例 SQL】按钮,输入问题描述、【示例 SQL】,并选择数据源,进行新建【SQL 示例】,填写完成后点击【保存】,【SQL 示例】创建成功。
1718
![add_data_training.png](../img/user_manual/setting/add_data_training.png)

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ nav:
4444
- 系统架构: system_arch.md
4545
- 安装部署:
4646
- 1Panel 安装: installation/1panel_installtion.md
47+
- 阿里云安装: installation/aliyun_installtion.md
4748
- 离线安装: installation/offline_installtion.md
4849
- 在线安装: installation/online_installtion.md
4950
- 离线升级: installation/offline_upgrade.md
@@ -82,6 +83,7 @@ nav:
8283
- MCP 服务: mcp_server.md
8384
- DataEase 接入: dataease_integration.md
8485
- 嵌入式对接: embedding_integration.md
86+
- 商业版本: buy.md
8587
- 联系我们: contact.md
8688

8789
markdown_extensions:

theme/f2c-header.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@
3838
<div class="mega-nav-body">
3939
<ul class="mega-nav-ul">
4040
<li><a href="https://1panel.cn/" target="_blank"><b>1Panel</b> - 现代化、开源的 Linux 面板</a></li>
41-
<li><a href="https://maxkb.cn" target="_blank"><b>MaxKB</b> - 强大易用的企业级智能体平台</a></li>
4241
<li><a href="https://jumpserver.org/" target="_blank"><b>JumpServer</b> - 广受欢迎的开源堡垒机</a></li>
43-
<li><a href="https://dataease.cn" target="_blank"><b>DataEase</b> - 人人可用的开源 BI 工具</a></li>
42+
<li><a href="https://maxkb.cn/" target="_blank"><b>MaxKB</b> - 强大易用的企业级智能体平台</a></li>
43+
<li><a href="https://cordys.cn/" target="_blank"><b>Cordys</b> - 新一代的 AI CRM 系统</a></li>
44+
<li><a href="https://dataease.cn/" target="_blank"><b>DataEase</b> - 人人可用的开源 BI 工具</a></li>
4445
<li><a href="https://www.fit2cloud.com/metersphere/index.html" target="_blank"><b>MeterSphere</b> - 新一代的开源持续测试工具</a></li>
4546
<li><a href="https://halo.run/" target="_blank"><b>Halo</b> - 强大易用的开源建站工具</a></li>
4647
</ul>

0 commit comments

Comments
 (0)