Skip to content

Commit db2179b

Browse files
committed
更新 v1.9 功能细节
1 parent c9c923a commit db2179b

File tree

12 files changed

+95
-39
lines changed

12 files changed

+95
-39
lines changed

docs/img/app/app_export.png

140 KB
Loading

docs/img/app/app_import.png

23.4 KB
Loading

docs/img/app/node_condition.png

162 KB
Loading

docs/img/app/upload_config.png

27.4 KB
Loading
690 KB
Loading

docs/img/dataset/dataset_zip.png

537 KB
Loading

docs/img/dataset/gen_question.png

167 KB
Loading
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 应用导出与导出
2+
3+
## 1 应用导出
4+
5+
!!! Abstract ""
6+
应用支持导出操作,导出后文件名称为:应用名称.mk。
7+
对于高级编排类型的应用,导出内容为包括工作流中所有节点的参数设置以及函数内容,流程节点中所选择的知识库和模型信息不导出。
8+
9+
![应用导出](<../../img/app/app_export.png>){ width="500px" }
10+
11+
## 2 应用导入
12+
13+
!!! Abstract ""
14+
在应用页面,点击【导入应用】,即可导入应用文件(文件后缀为.mk)。
15+
16+
![应用导入](<../../img/app/app_import.png>){ width="500px" }

docs/user_manual/app/workflow_app.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,17 @@
3131
点击右上角的【添加组件】,可以点击或拖拽到画布进行工作流编排。以下是每个组件的用途说明:
3232

3333
* AI对话:与AI大模型进行对话节点。
34+
* 图片理解:识别并理解图片所包含的信息。
35+
* 图片生成:根据提供的文本内容生成图片。
3436
* 知识库检索:关联知识库,检索与问题相关分段的节点。
35-
* 问题优化:AI对话的一种,设定了默认的角色和提示词,根据上下文优化问题。
36-
* 判断器:根据不同条件执行不同的节点。
37-
* 指定回复:直接指定回复内容。
3837
* 多路召回:使用重排模型队多个知识库的检索结果进行二次召回。
39-
* 文档内容提取:提取文档中的内容
40-
* 图片理解:识别并理解图片所包含的信息
38+
* 判断器:根据不同条件执行不同的节点
39+
* 指定回复:直接指定回复内容
4140
* 表单收集:通过表单的方式收集问答所需要的必要信息。
41+
* 问题优化:AI对话的一种,设定了默认的角色和提示词,根据上下文优化问题。
42+
* 文档内容提取:提取文档中的内容。
43+
* 语音转文本:将音频转换为文本。
44+
* 文本转语音:将文本转换为语音。
4245

4346
![编排画布](../../img/app/workflow.png)
4447

@@ -50,7 +53,7 @@
5053
![开始节点](../../img/app/start_node.png){width="500px"}
5154

5255
!!! Abstract ""
53-
- 文件上传: 开启后应用将支持在对话时上传文档、图片文件,并在后续节点中可以对上传后的文件进行解析。
56+
- 文件上传: 开启后应用将支持在对话时上传文档、图片以及音频文件,并在后续节点中可以对上传后的文件进行解析。
5457
![开始节点-文件上传](../../img/app/upload_config.png){width="500px"}
5558

5659
!!! Abstract ""
@@ -78,8 +81,10 @@
7881
!!! Abstract ""
7982
参数输出:
8083

81-
- 用户问题 {question}:用户输入的提问信息。
82-
- 文档 {document}:用户上传的文档。
84+
- 用户问题 {question}:客户端输入的提问信息。
85+
- 文档 {document}:客户端上传的文档。
86+
- 图片 {image}: 客户端上传的图片文件。
87+
- 音频 {audio}: 客户端上传的音频文件。
8388

8489
### 1.3 AI 对话
8590

@@ -128,7 +133,7 @@
128133

129134
!!! Abstract ""
130135
节点说明:根据文本描述生成对应的图片。
131-
![图片生成](../../img/app/vision_gen.png)
136+
![图片生成](../../img/app/vision_gen.png){width="300px"}
132137

133138
!!! Abstract ""
134139
节点设置:
@@ -335,7 +340,17 @@
335340

336341
- 结果:即子应用的返回结果。
337342

338-
## 4 调试
343+
## 4 执行条件
344+
345+
!!! Abstract ""
346+
MaxKB 工作流中支持多出多进,在这个情况下,汇集节点可以根据与前置节点的逻辑关系,选择执行条件。
347+
348+
- ALL:需要等所有前置连线节点全部执行完成后,才可执行当前节点。
349+
- ANY:任一前置连线节点执行完成后,即可执行当前节点。
350+
351+
![执行条件](../../img/app/node_condition.png){width="280px"}
352+
353+
## 5 调试
339354

340355
!!! Abstract ""
341356
完成所有的编排设计后,可点击【调试】后,先校验流程是否合规,校验通过后可在当前页面进行对话测试。
@@ -347,14 +362,14 @@
347362

348363
![执行详情](../../img/app/exec_detail.png)
349364

350-
## 5 保存
365+
## 6 保存
351366

352367
!!! Abstract ""
353368
高级编排流程默认手动保存,也可设置自动保存,开启自动保存后将每隔 1 分钟保存到本地,并在发布成功后将配置同步到后台数据库。
354369

355370
![自动保存](../../img/app/auto_save.png)
356371

357-
## 6 发布
372+
## 7 发布
358373

359374
!!! Abstract ""
360375
点击【发布】后会先校验当前工作流是否符合规则,如果合规将成功发布,否则发布失败。发布成功后,所有节点配置修改才在问答页面中生效。可以查看发布历史并进行版本恢复。

docs/user_manual/dataset/dataset.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,22 @@
2121
输入知识库名称、知识库描述,选择向量模型并设置知识库类型为通用型,然后将离线文档通过拖拽或选择文件方式进行上传。
2222
上传文档要求:
2323

24-
* 文本文件::Markdown、TXT、PDF、DOCX、HTML;
25-
* 表格:Excel、CSV;
26-
* QA 问答对:Excel、CSV;
24+
* 文本文件::Markdown、TXT、PDF、DOCX、HTML、XLS、XLSX、CSV、ZIP
25+
* 表格:XLS、XLSX、CSV、ZIP;
26+
* QA 问答对:XLS、XLSX、CSV、ZIP
2727
* 每次最多上传 50 个文件;
2828
* 每个文件不超过 100 MB;
2929
* 支持选择文件夹,上传文件夹下符合要求的文件。
3030
31-
文档规范建议:
31+
!!! Abstract ""
32+
**说明:** ZIP 文件包括两种形式:
3233

33-
* **分段标识规范**:离线文档的分段标识要有一定规范,否则拆分出来的段落不规整。
34-
* **段落完整**:在一个分段中集中描述一个完整的内容。
34+
* MarkDown 文档 + 图片文件,MarkDown 文档中引入对应的图片,并将两者打包在 ZIP 中。
35+
* XLS/XLSX 文件 + 图片文件,XLS/XLSX 文件中引入对应的图片,并将两者打包在 ZIP 中。
3536

3637
![上传文档](../../img/dataset/create_offline_dataset.png)
3738

38-
39+
3940
!!! Abstract ""
4041
对于知识库文件的分段,目前 MaxKB 支持智能分段以及高级分段两种方式。
4142

@@ -55,8 +56,15 @@
5556

5657
* 按照标题# 进行分段,若没有#标题的则按照字符数4096个字符进行分段;
5758
* 查找分段长度以内的回车进行截取。
58-
59+
5960
![智能分段](<../../img/dataset/automatic_paragraphing.png>)
61+
62+
!!! Abstract ""
63+
文档规范建议:
64+
65+
* **分段标识规范**:离线文档的分段标识要有一定规范,否则拆分出来的段落不规整。
66+
* **段落完整**:在一个分段中集中描述一个完整的内容。
67+
6068
!!! Abstract ""
6169
**高级分段**
6270

@@ -138,9 +146,11 @@
138146
### 2.4 导出知识库
139147

140148
!!! Abstract ""
141-
在知识库列表,点击知识库面板的【…】->【导出】,将知识库中文档和分段内容以 excel 格式导出,每个文档为一个 sheet,每一行展示一个分段。
149+
在知识库列表,点击知识库面板的【…】->【导出EXCEL】/【导出ZIP】。将知识库的分段内容以Excel或ZIP文件格式导出。
150+
每个文档为 Excel 文件的一个 sheet,sheet 每一行展示一个分段。导出 ZIP 文件时,会将引用的图片一起导出,且以 guid 的方式进行命名,且没有格式扩展名。
142151

143152
![知识库导出](../../img/dataset/dataset_export.png)
153+
![知识库导出](../../img/dataset/dataset_zip.png){ width="500px" }
144154

145155
### 2.5 删除知识库
146156

0 commit comments

Comments
 (0)