优化文字描述说明

Andyguo5891 · Andyguo5891 · commit 2a1918d07a88 · 2025-02-05T14:34:27.000+08:00
diff --git a/docs/img/dataset/create_offline_dataset.png b/docs/img/dataset/create_offline_dataset.png
diff --git a/docs/img/index/mount_pgsqldir2.png b/docs/img/index/mount_pgsqldir2.png
diff --git a/docs/installation/1panel_installtion.md b/docs/installation/1panel_installtion.md
@@ -23,7 +23,7 @@
     - 容器名称：MaxKB 应用容器名称。    
     - CPU 限制：MaxKB 应用可以使用的 CPU 核心数。   
     - 内存限制：MaxKB 应用可以使用的内存大小。    
-    - 端口外部访问：MaxKB 应用可以使用 IP:PORT 进行访问（MaxKB 应用必须打开外部端口访问）。   
+    - 端口外部访问：MaxKB 应用可以使用 IP:PORT 进行访问（MaxKB 应用必须勾选外部端口访问）。   
 
 ![maxkb-setting](../img/index/maxkb_setting.jpg)
 
@@ -45,6 +45,6 @@
     密码: MaxKB@123..
     ``` 
 
-    为了安全，admin 第一次登录时将强制修改默认密码，修改密码后，重新登录系统即可使用 MaxKB。   
+    为了安全，admin 第一次登录时将要求修改默认密码，修改密码后，重新登录系统即可使用 MaxKB。   
 
 ![登录成功](../img/index/UI.jpg)
diff --git a/docs/installation/cli.md b/docs/installation/cli.md
@@ -5,8 +5,8 @@
 
     **说明**：
 
-    - 1.5.0 版本之前请使用 kbctl 命令。
-    - 通过在线安装、1panel安装，并没有内置 mkctl 命令。
+    - 1.5.0 之前版本请使用 kbctl 命令。
+    - 通过在线安装、1Panel方式安装，并没有内置 mkctl 命令。
 
     ```
     Usage:
@@ -22,4 +22,5 @@
     uninstall           卸载 MaxKB 服务
     upgrade             升级 MaxKB 服务
     version             查看 MaxKB 版本信息
+    clean-images        清理 MaxKB 旧版本的相关镜像
     ```
diff --git a/docs/installation/offline_installtion.md b/docs/installation/offline_installtion.md
@@ -18,10 +18,10 @@
 !!! Abstract ""
     离线部署 MaxKB 需要开通的访问端口说明如下：
 
-| 端口     | 作用       | 说明                       |
-|--------|:---------|:-------------------------|
-| 22     | SSH      | 安装、升级及管理使用               |
-| 8080   | Web 服务端口 | 默认 Web 服务访问端口，根据实际情况进行更改 |
+| 端口     | 作用       | 说明                        |
+|--------|:---------|:--------------------------|
+| 22     | SSH      | 安装、升级及管理使用                |
+| 8080   | Web 服务端口 | 默认 Web 服务访问端口，可根据实际情况进行更改 |
 
 
 
@@ -45,7 +45,7 @@
 
 !!! Abstract ""
 
-    MaxKB 安装目录、服务运行端口、数据库配置等信息可在安装包中的 install.conf 文件进行配置。
+    MaxKB 安装目录、服务运行端口、数据库配置等信息可在安装包解压后中的 install.conf 文件进行配置。
 
     ```
     ## 安装目录
@@ -69,7 +69,7 @@
     MAXKB_PGSQL_PASSWORD=Password123@postgres
     ```
 
-    **注意**：首次安装之前可在 install.conf 文件中的修改参数，安装时则根据修改后的参数执行安装。完成安装后如需再次修改配置参数，则需要在 ${MAXKB_BASE}/maxkb/.env 文件中进行修改，并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
+    **注意**：首次安装之前可在 install.conf 文件中的修改参数，安装时则根据修改后的参数执行安装。完成安装后如需再次修改配置参数，则需要在 ${MAXKB_BASE}/maxkb/.env（默认是 /op/maxkb/.env）文件中进行修改，并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
 
 
 ### 3.3 执行安装脚本
@@ -103,14 +103,14 @@
 
 !!! Abstract ""
 
-    按照以上说明，下载新版本安装包并上传解压后，再次执行安装命令进行升级。
+    离线升级与安装操作过程基本一样，即下载新版本安装包上传解压后，再次执行安装命令进行升级。
 
     ```
     # 进入新版本目录
     cd maxkb-v1.x.y-offline
 
     # 运行安装脚本
-    /bin/bash install.sh
+    bash install.sh
 
     # 查看 MaxKB 运行状态
     mkctl status
diff --git a/docs/installation/online_installtion.md b/docs/installation/online_installtion.md
@@ -16,10 +16,10 @@
 
     在线部署 MaxKB 需要开通的访问端口说明如下：
 
-| 端口     | 作用       | 说明                       |
-|--------|:---------|:-------------------------|
-| 22     | SSH      | 安装、升级及管理使用               |
-| 8080   | Web 服务端口 | 默认 Web 服务访问端口，根据实际情况进行更改 |    
+| 端口     | 作用       | 说明                        |
+|--------|:---------|:--------------------------|
+| 22     | SSH      | 安装、升级及管理使用                |
+| 8080   | Web 服务端口 | 默认 Web 服务访问端口，可根据实际情况进行更改 |    
 
 
 ## 2 在线快速部署
@@ -54,12 +54,12 @@
     ```
     docker pull cr2.fit2cloud.com/1panel/maxkb
     ```
-    （2）查看并确认上一次数据持久化目录，复制保存，第（4）步使用
+    （2）查看并确认上一次数据持久化目录，复制保存
     ```
     docker inspect maxkb
     ```
 
-![获取pgsql目录](../img/index/mount_pgsqldir.png)
+![获取pgsql目录](../img/index/mount_pgsqldir2.png)
 
 !!! Abstract ""
 
@@ -71,8 +71,8 @@
 
     （4）启动并运行新版本的 MaxKB 容器
 
-    **注意：** 务必确认数据持久化目录（即命令行中 -v后的目录）要跟第 (2) 步查看目录保持一致，否则启动后整个系统数据为空。
+    **注意：** 务必确认数据持久化目录（即命令行中 -v后的目录）要跟第 (2) 步查看目录保持一致，否则启动后整个系统的数据为空。
 
     ```
-    docker run -d --name=maxkb -p 8080:8080 -v /opt/maxkb/pgsql/data:/var/lib/postgresql/data -v /opt/maxkb/python-packages:/opt/maxkb/app/sandbox/python-packages cr2.fit2cloud.com/1panel/maxkb
+    docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/var/lib/postgresql/data -v ~/.python-packages:/opt/maxkb/app/sandbox/python-packages cr2.fit2cloud.com/1panel/maxkb
     ```
diff --git a/docs/quick_start.md b/docs/quick_start.md
@@ -3,12 +3,12 @@
 
 !!! Abstract ""
     MaxKB 的使用操作流程一般可分为四步：添加模型、创建知识库、创建应用、发布应用。     
-    在高级编排应用中还可以通过函数库的功能，创建数据处理、逻辑判断、信息提取或者其他满足工作场景的函数脚本，提供更加强大、灵活的能力。
+    在高级编排应用中还可以通过函数库的功能，实现数据处理、逻辑判断、信息提取等功能，提供更加强大、灵活的能力。
 
-![通义千问 APIkey](img/model/maxkb_flow.png)
+![操作流程](img/model/maxkb_flow.png)
 
 !!! Abstract ""
-    下面通过通义千问大语言模型，以通用知识库为例，快速创建智能问答应用并发布。
+    下面以通用知识库为例，通过通义千问大语言模型，快速创建智能问答应用并发布为例说明具体的操作。
 
 ## 2 添加模型
 
@@ -38,7 +38,7 @@
 !!! Abstract ""
     上传文档要求：  
 
-    * 文件格式：Markdown、TXT、PDF、DOCX、HTML；
+    * 文本文件:：Markdown、TXT、PDF、DOCX、HTML、XLS、XLSX、CSV、ZIP；
     * 表格格式：Excel、CSV;
     * QA 问答对：Excel、CSV；  
     * 每次最多上传 50 个文件；   
@@ -47,31 +47,31 @@
 
     文档规范建议：
 
-    * 规范分段标识：离线文档的分段标识要有一定规范，否则拆分出来的段落会不规整。   
-    * 段落要完整：一个分段中最好能描述一个完整的功能点或问题。
+    * 规范分段标识：离线文档的分段标识要有一定规范，否则拆分出来的段落不规整。   
+    * 段落要完整：一个分段中最好能描述一个完整的内容。
 
 ![创建通用知识库](img/dataset/create_offline_dataset.png)
 
 ### 3.2 设置分段规则
     
 !!! Abstract ""
-    目前 MaxKB 支持智能分段和高级分段两种分段方式。
+    MaxKB 支持智能分段和高级分段两种分段方式。
 
     **智能分段**
 
     （1）MarkDown 类型的文件智能分段规则：<br />
 
-    * 根据标题逐级下钻式分段，最多支持 6 级标题，每段的字符数最大为 4096 个字符；   
+    * 根据标题逐级下钻式分段，最多支持 6 级标题，每个段落最多 4096 个字符；   
     * 当最后一级的文本段落字符数超过设置的分段长度时，会查找分段长度以内的回车进行截取。
 
     （2）HTML、DOCX 类型的智能分段规则：
 
     * 识别标题格式转换成 markdown 的标题样式；
-    * 逐级下钻进行分段，最多支持 6 级标题，每段的字符数最大为 4096 个字符。
+    * 逐级下钻进行分段，最多支持 6 级标题，每个段落最多 4096 个字符。
 
     （3）TXT和 PDF 类型的文件智能分段规则：
 
-    * 按照标题# 进行分段，若没有#标题的则按照字符数4096个字符进行分段；
+    * 按照标题# 进行分段，若没有#标题的则按照字符数 4096 个字符进行分段；
     * 查找分段长度以内的回车进行截取。  
       
 ![智能分段](<img/dataset/automatic_paragraphing.png>)
@@ -83,9 +83,10 @@
 
     * 分段标识支持：#、##、###、####、#####、######、-、空行、回车、空格、分号、逗号、句号，还可以手动输入分段标识符。   
     * 分段长度：支持最小 50个字符，最大 4096 个字符。   
-    * 自动清洗：开启后系统会自动去掉重复多余的符号如空格、空行、制表符等。     
+    * 自动清洗：开启后系统会自动去掉重复多余的符号，例如空格、空行、制表符等。     
 
 ![高级分段](<img/dataset/advanced_segmentation.png>)
+
 !!! Abstract ""
     **导入时添加分段标题为关联问题**  
 
@@ -123,7 +124,7 @@
     * 应用名称：用户提问时对话框的标题和名字。    
     * 应用描述：对应用场景及用途的描述。    
     * AI模型：在【系统设置】-【模型管理】中添加的大语言模型。    
-    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，可以引导大模型聊天方向。可以对无引用知识库和引用知识库两种情况分别设置不同的提示词。
+    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，引导大模型聊天方向。可对无引用知识库和引用知识库两种情况分别设置不同的提示词。
     * 历史聊天记录：大模型提交当前会话中最后 N 条对话内容，否则仅向大模型提交当前问题。
     * 关联知识库：用户提问后将在关联的知识库中检索分段。   
     * 开场白：用户打开对话时，系统弹出的问候语。支持 Markdown 格式；[-]后的内容为快捷问题，一行一个。 
@@ -168,12 +169,12 @@
 !!! Abstract "" 
     MaxKB 应用支持零编码快速嵌入第三方 Web系统。
 
-    在应用概览页面，点击【嵌入第三方】，可以复制全屏模式代码或浮窗模式代码嵌入到第三方系统中，嵌入完成后便可在第三方系统中进行问答。
+    在应用概览页面，点击【嵌入第三方】，复制对应的嵌入代码，以全屏模式或浮窗模式嵌入到第三方系统中，嵌入完成后便可在第三方系统中进行问答。
 
 ![嵌入第三方](<img/app/embed.png>)
 
 !!! Abstract "" 
-    在专业版中，也可以接入企业微信、公众号、钉钉和飞书等应用，详细说明见：[X-Pack功能-应用接入 ](./user_manual/X-Pack/app_integrate.md)。
+    在专业版中，还可以将 MaxKB 应用接入企业微信、公众号、钉钉和飞书等移动端应用，详细说明见：[X-Pack功能-应用接入 ](./user_manual/X-Pack/app_integrate.md)。
 
     
 
diff --git a/docs/system_arch.md b/docs/system_arch.md
@@ -2,11 +2,11 @@
 
 ## 1 整体架构
 
-![架构图](img/index/arch.jpg)
+![架构图](img/index/arch.jpg){width="950px"}
 
 ## 2 实现原理
 
-![实现原理](<img/index/Implementation principle.jpg>)
+![实现原理](img/index/Implementation principle.jpg)
 
 ## 3 技术栈
 
diff --git a/docs/user_manual/dataset/dataset.md b/docs/user_manual/dataset/dataset.md
@@ -44,13 +44,13 @@
 
     （1）MarkDown 类型文件智能分段规则<br />
 
-    * 根据标题逐级下钻式分段（最多支持 6 级标题），每段的字符数最大为 4096 个字符；   
+    * 根据标题逐级下钻式分段（最多支持 6 级标题），每个段落最多 4096 个字符；   
     * 当最后一级的文本段落字符数超过设置的分段长度时，会查找分段长度以内的回车进行截取。
 
     （2）HTML、DOCX 类型智能分段规则
 
     * 识别标题格式转换成 markdown 的标题样式；
-    * 逐级下钻进行分段（最多支持 6 级标题）每段的字符数最大为 4096 个字符。
+    * 逐级下钻进行分段（最多支持 6 级标题），每个段落最多 4096 个字符。
 
     （3）TXT和 PDF 类型文件智能分段规则
 
diff --git a/docs/user_manual/dataset/doclist.md b/docs/user_manual/dataset/doclist.md
@@ -3,19 +3,19 @@
 ## 1 文档上传
 
 !!! Abstract ""
-    对于通用型知识库，点击【上传文档】进入上传文档页面，可以拖拽文件或选择文件/文件夹进行上传，支持的文件格式包括：TXT、Markdown、PDF、DOCX、HTML、XLS、XLSX、CSV、ZIP。如果选择文件夹，将通过文件后缀进行自动过滤。每次最多上传 50 个文件，单个文件不超过 100 MB。
+    对于通用型知识库，点击【上传文档】进入上传文档页面，可以拖拽文件或选择文件/文件夹进行上传，支持的文件格式包括：TXT、Markdown、PDF、DOCX、HTML、XLS、XLSX、CSV、ZIP。如果选择文件夹，将通过文件后缀进行自动过滤，每次最多上传 50 个文件，且单个文件不超过 100 MB。
 
 ![上传文档](../../img/dataset/create_offline_dataset.png)
 
 !!! Abstract ""
-    点击下一步进入【设置分段规则】，可以对上传文档选择分段规则，默认为智能分段。分段规则变更后可以点击【生成预览】后将按照最新规则进行分段展示。点击【开始导入】后，系统会在后台对文档按照自动分段 -> 存储 -> 向量化流程处理。
+    点击【下一步】，对上传文档选择分段规则，默认为智能分段。分段规则变更后需点击【生成预览】，确认分段效果，然后点击【开始导入】，系统将对文档按照自动分段 -> 存储 -> 向量化流程处理。
 
 ![智能分段](<../../img/dataset/auto_paragraph.png>)
 
 !!! Abstract "" 
-    对于 Web 站点知识库，点击【导入文档】打开对话框，输入文档链接和选择器。以分行输入的方式输入多个在线 Web 文档。
+    对于 Web 站点知识库，点击【导入文档】打开对话框，输入文档链接 URL 地址和选择器，即可同步对应内容。
 
-![导入文档](../../img/dataset/upload_web_doc.png)
+![导入Web文档](../../img/dataset/upload_web_doc.png)
 
 ## 2 同步知识库
 
diff --git a/docs/user_manual/dataset/hit-testing.md b/docs/user_manual/dataset/hit-testing.md
@@ -1,7 +1,7 @@
 # 命中测试
 
 !!! Abstract ""  
-    知识库命中测试是对提问进行提前验证，点击【命中测试】，输入测试问题，系统在当前知识库中向量检索与问题相关的分段，然后按照相似度和返回Top 分段数等参数返回命中结果。知识库管理员可以根据命中测试返回分段内容，对分段进行再次编辑或添加关联问题以进一步提升和优化回答效果。
+    知识库命中测试是对提问进行提前验证，点击【命中测试】，输入测试问题，系统在当前知识库中向量检索与问题相关的分段，然后按照相似度和返回Top 分段数等参数返回命中结果，可以根据命中测试返回分段内容，对分段进行再次编辑或添加关联问题，以进一步提升和优化回答效果。
 ![命中测试](../../img/dataset/hittesting.png)
 
 
diff --git a/docs/user_manual/model/azure_openai_model.md b/docs/user_manual/model/azure_openai_model.md
@@ -11,7 +11,7 @@
 
     * 模型名称：MaxKB 中自定义的模型名称。   
     * 权限：分为私有和公用两种权限，私有模型仅当前用户可用，公用模型即系统内所有用户均可使用，但其它用户不能编辑和删除。    
-    * 模型类型：大语言模型。   
+    * 模型类型：大语言模型/向量模型/语音识别/语音合成/图片理解/图片生成。   
     * 基础模型：具体的基础模型由部署名决定，见上图。 
     * API 版本：模型版本
     * API 域名：Azure OpenAI 项目 API 服务 URL，见上图。
@@ -23,4 +23,4 @@
 !!! Abstract "" 
     Azure OpenAI-大语言模型配置样例图示：
 
-![Azure模型](../../img/model/azure_model.png)
+![Azure_大语言模型](../../img/model/azure_model.png)
diff --git a/docs/user_manual/model/gemini_model.md b/docs/user_manual/model/gemini_model.md
@@ -9,7 +9,7 @@
 
     * 模型名称：MaxKB 中自定义的模型名称。    
     * 权限：分为私有和公用两种权限，私有模型仅当前用户可用，公用模型即系统内所有用户均可使用，但其它用户不能编辑和删除。     
-    * 模型类型：大语言模型。   
+    * 模型类型：大语言模型/向量模型/语音识别/图片理解。   
     * 基础模型：不同类型模型下的基础模型名称，下拉选项是常用的一些基础模型名称，支持自定义输入。
     * API Key：获取 API Key。
 
@@ -20,4 +20,4 @@
 !!! Abstract ""
     Gemini-大语言模型配置样例图示：
 
-![gemini 模型](../../img/model/gemini_llm.png){ width="500px" }
+![gemini 大语言模型](../../img/model/gemini_llm.png){ width="500px" }
