Skip to content

Commit a283ada

Browse files
committed
feat:修正前后空格和错误表达
1 parent e2cdfd5 commit a283ada

6 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/installation/offline_installtion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
MAXKB_PGSQL_PASSWORD=Password123@postgres
7070
```
7171

72-
**注意**:首次安装之前可在 install.conf文件中的修改参数,安装时则根据修改后的参数执行安装。完成安装后如需再次修改配置参数,则需要在 ${MAXKB_BASE}/maxkb/.env(默认是 /opt/maxkb/.env)文件中进行修改,并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
72+
**注意**:首次安装之前可在 install.conf 文件中的修改参数,安装时则根据修改后的参数执行安装。完成安装后如需再次修改配置参数,则需要在 ${MAXKB_BASE}/maxkb/.env(默认是 /opt/maxkb/.env)文件中进行修改,并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
7373

7474

7575
### 3.3 执行安装脚本

docs/installation/tencent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
!!! Abstract ""
1919

20-
第三步:选择合适云资源配置。点击【安装应用】后,设置云资源设置,建议至少 4c8g 及以上规格。
20+
第三步:选择合适云资源配置。点击【安装应用】后,设置云资源设置,建议至少 4C8G 及以上规格。
2121

2222
![应用资源](../img/index/app_resource.png)
2323
![应用资源](../img/index/app_resource2.png)

docs/quick_start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
![操作流程](img/model/maxkb_flow.png)
4040

4141
!!! Abstract ""
42-
下面以通用知识库为例,通过公有模型服务通义千问(本地模型部署操作,例如,DeepSeek部署,请参考[使用1Panel开源面板快速部署DeepSeek-R1](https://mp.weixin.qq.com/s/bF253jBHZIWIHvNnSMv-Rg)),快速创建智能问答应用并发布说明具体操作。
42+
下面以通用知识库为例,通过公有模型服务通义千问(本地模型部署操作,例如,DeepSeek 部署,请参考[使用1Panel开源面板快速部署DeepSeek-R1](https://mp.weixin.qq.com/s/bF253jBHZIWIHvNnSMv-Rg)),快速创建智能问答应用并发布说明具体操作。
4343

4444
### 2.1 添加模型
4545

@@ -50,7 +50,7 @@
5050
* 权限:分为私有和公用两种权限,私有模型仅当前用户可用,公用模型即系统内所有用户均可使用,但其它用户不能编辑。
5151
* 模型类型:大语言模型。
5252
* 基础模型:通义千问支持的 LLM 模型名称,下拉选项是常用的一些大语言模型名称,支持自定义输入。
53-
* API Key:阿里云 DashScope灵积模型服务 API Key管理中创建和查看。
53+
* API Key:阿里云 DashScope 灵积模型服务 API Key管理中创建和查看。
5454

5555
![通义千问 APIkey](img/model/tongyi_model.png)
5656

@@ -110,7 +110,7 @@
110110
用户可以根据文档规范自定义设置分段标识符、分段长度及自动清洗。
111111

112112
* 分段标识支持:#、##、###、####、#####、######、-、空行、回车、空格、分号、逗号、句号,还可以手动输入分段标识符。
113-
* 分段长度:支持最小 50个字符,最大 100000 个字符。
113+
* 分段长度:支持最小 50 个字符,最大 100000 个字符。
114114
* 自动清洗:开启后系统会自动去掉重复多余的符号,例如空格、空行、制表符等。
115115

116116
![高级分段](<img/dataset/advanced_segmentation.png>)

docs/user_manual/app/workflow_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969

7070
- 接口传参:在通过应用公开访问链接时可配置的参数。添加接口参数后将会在公开访 URL 自动增加接口参数,在与第三方系统集成。
7171
- 语音输入:开启后将支持以语音的方式进行问题的输入,需要使用语音识别模型。
72-
- 语音播放:开启后回答内容将以语音的方式进行播放,可以使用浏览器内置的播放,也可以使用语音合成模型进行摸播放
72+
- 语音播放:开启后回答内容将以语音的方式进行播放,可以使用浏览器内置的播放,也可以使用语音合成模型进行播放
7373

7474
### 1.2 开始
7575

docs/user_manual/dataset/hit-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 命中测试
22

33
!!! Abstract ""
4-
知识库命中测试是对提问进行提前验证,点击【命中测试】,输入测试问题,系统在当前知识库中向量检索与问题相关的分段,然后按照相似度和返回Top 分段数等参数返回命中结果,可以根据命中测试返回分段内容,对分段进行再次编辑或添加关联问题,以进一步提升和优化回答效果。
4+
知识库命中测试是对提问进行提前验证,点击【命中测试】,输入测试问题,系统在当前知识库中向量检索与问题相关的分段,然后按照相似度和返回 Top 分段数等参数返回命中结果,可以根据命中测试返回分段内容,对分段进行再次编辑或添加关联问题,以进一步提升和优化回答效果。
55
![命中测试](../../img/dataset/hittesting.png)
66

77

docs/user_manual/fx/fx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
![内置函数](../../img/fx/system_fx.png)
2020

2121
!!! Abstract ""
22-
内置函数添加到函数库后,需要配置启动参数,例如数据库连接信息、API Key等,并启用后才可以在高级编排应用中使用。
22+
内置函数添加到函数库后,需要配置启动参数,例如数据库连接信息、API Key 等,并启用后才可以在高级编排应用中使用。
2323

2424
![启动函数](../../img/fx/system_func_params1.png){width="800px"}
2525
![启动函数](../../img/fx/system_func_params2.png)
@@ -29,7 +29,7 @@
2929
### 2.1 函数依赖包安装
3030

3131
!!! Abstract ""
32-
如果函数实现需要安装第三方依赖包,可在 maxkb 容器中使用 pip 命令进行安装。
32+
如果函数实现需要安装第三方依赖包,可在 MaxKB 容器中使用 pip 命令进行安装。
3333

3434
```
3535
# 进入 maxkb 容器中
@@ -48,7 +48,7 @@
4848

4949
- 函数名称:函数的 logo 以及函数名称,便于识别。函数 logo 在保存后可自定义上传。
5050
- 描述:函数详细说明以及使用注意事项,会显示在高级编排应用的组件列表中。
51-
- 启动参数:启用参数即函数运行的必要参数,例如 API Key等。将启动参数与输入参数分离,在工作流中仅关注输入参数,同时也避免关键信息的泄露。
51+
- 启动参数:启用参数即函数运行的必要参数,例如 API Key 等。将启动参数与输入参数分离,在工作流中仅关注输入参数,同时也避免关键信息的泄露。
5252
- 输入参数:函数的输入参数,参数的数据类别包括:string、int、float、array,可自定义赋值,也可引用参数。
5353
- 函数内容:自定义编写 Python 函数代码,可以引用输入变量。
5454
- 输出参数:Python 代码执行返回的结果。

0 commit comments

Comments
 (0)