增加 v1.7.2更新日志以及优化文档。

Author: Andyguo5891

docs/changelog.md

@@ -9,6 +9,18 @@
 
 ## 2 更新内容
 
+### v1.7.2
+
+2024 年 11 月 15 日
+
+!!! Abstract "问题修复 :palm_tree:"
+    - 应用：修复显示设置中自定义上传的用户头像、AI回复头像图片显示变形的问题。
+    - 应用：修复工作流中知识库检索节点收起后，无法发布应用的问题。
+    - 应用：修复AI模型的参数设置中，若删除温度或最大输出 Tokens 参数，无法发布应用的问题。
+    - 应用：修复应用中关联的知识库名称过长时，偶然不显示 tooltips 的问题。
+    - 应用：修复应用列表中查询结果显示不正确的问题。
+
+
 ### v1.7.1
 
 2024 年 11 月 8 日

docs/img/model/tongyi_model.png

@@ -1,8 +1,12 @@
 ## 1 mkctl 命令
 
 !!! Abstract ""
-    MaxKB 离线安装包默认内置了命令行运维工具 mkctl，通过执行 `mkctl help`，可以查看相关的命令说明。    
-    **说明**：1.5.0 版本之前请使用 kbctl 命令。
+    MaxKB 离线安装包默认内置了命令行运维工具 mkctl，通过执行 `mkctl help`，可以查看相关的命令说明。  
+
+    **说明**：
+
+    - 1.5.0 版本之前请使用 kbctl 命令。
+    - 通过在线安装、1panel安装，并没有内置 mkctl 命令。
 
     ```
     Usage:

docs/installation/cli.md

@@ -1,6 +1,7 @@
 ## 1 部署要求
 
-如果用于生产环境，离线安装是官方推荐的安装方式。
+!!! Abstract ""
+    如果用于生产环境，离线安装是官方推荐的安装方式。
 
 ### 1.1 服务器配置
 
@@ -17,11 +18,13 @@
 !!! Abstract ""
     离线部署 MaxKB 需要开通的访问端口说明如下：
 
-| 端口     |    作用    |            说明            |
-|--------|:--------:|:------------------------:|
-| 22     |   SSH    |        安装、升级及管理使用        |
+| 端口     | 作用       | 说明                       |
+|--------|:---------|:-------------------------|
+| 22     | SSH      | 安装、升级及管理使用               |
 | 8080   | Web 服务端口 | 默认 Web 服务访问端口，根据实际情况进行更改 |
 
+
+
 ## 2 安装包下载
 
 !!! Abstract ""
@@ -33,7 +36,7 @@
 
 !!! Abstract ""
 
-    以 root 用户使用 ssh 协议登录到部署服务器, 对安装包进行解压：
+    以 root 用户通过 ssh 协议登录到部署服务器, 对安装包进行解压：
     ```
     tar -zxvf maxkb-v1.2.0-offline.tar.gz
     ```
@@ -87,7 +90,7 @@
 
 !!! Abstract ""
 
-    安装成功后，通过浏览器访问地址 `http://目标服务器 IP 地址:8080`，使用默认的管理员用户和密码登录MaxKB。
+    待所有容器状态显示为`healthy`后，即可通过浏览器访问地址 `http://目标服务器 IP 地址:8080`，并使用默认的管理员用户和密码登录 MaxKB。
 
     ```
     用户名：admin
@@ -100,7 +103,7 @@
 
 !!! Abstract ""
 
-    按照以上说明，下载新版本安装包并上传解压后，重新执行安装命令进行升级。
+    按照以上说明，下载新版本安装包并上传解压后，再次执行安装命令进行升级。
 
     ```
     # 进入新版本目录

docs/installation/offline_installtion.md

@@ -16,9 +16,9 @@
 
     在线部署 MaxKB 需要开通的访问端口说明如下：
 
-| 端口     |    作用    |            说明            |
-|--------|:--------:|:------------------------:|
-| 22     |   SSH    |        安装、升级及管理使用        |
+| 端口     | 作用       | 说明                       |
+|--------|:---------|:-------------------------|
+| 22     | SSH      | 安装、升级及管理使用               |
 | 8080   | Web 服务端口 | 默认 Web 服务访问端口，根据实际情况进行更改 |    
 
 
@@ -35,7 +35,7 @@
     docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/var/lib/postgresql/data -v C:/python-packages:/opt/maxkb/app/sandbox/python-packages cr2.fit2cloud.com/1panel/maxkb
     ```
      
-    安装成功后，可通过浏览器访问 MaxKB：
+    待所有容器状态显示为`healthy`后，可通过浏览器访问 MaxKB：
     ```
     http://目标服务器 IP 地址:8080
 
@@ -54,7 +54,7 @@
     ```
     docker pull cr2.fit2cloud.com/1panel/maxkb
     ```
-    （2）查看并确认上一次数据持久化目录，复制保存，第4步使用
+    （2）查看并确认上一次数据持久化目录，复制保存，第（4）步使用
     ```
     docker inspect maxkb
     ```
@@ -63,15 +63,15 @@
 
 !!! Abstract ""
 
-    （3）删除正在运行的 MaxKB 容器
+    （3）删除正在运行的、旧版本的 MaxKB 容器
 
     ```
     docker rm -f maxkb 
     ```
 
-    （4）创建并启动 MaxKB 容器
+    （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

docs/installation/online_installtion.md

@@ -3,21 +3,20 @@
 
 !!! Abstract ""
     使用浏览器打开服务地址：http://目标服务器IP地址:目标端口。   
-    默认的登录信息：  
-    用户名：admin    
+    内置用户名：admin    
     默认密码：MaxKB@123.. 
 
 ## 2 添加模型
 
 !!! Abstract ""
     登录 MaxKB 系统后，可以在【系统管理-模型设置】中添加模型，也可以在创建应用时再添加模型。
-    在供应商列表中选择指定供应商，然后点击【添加模型】，进入模型配置表单。
+    在供应商列表中选择指定供应商，然后点击【添加模型】，进入模型配置表单，不同的平台参数要求不同，基本配置参数如下：
 
     * 模型名称：MaxKB 中自定义的模型名称。   
     * 模型类型：包括大语言模型/向量模型/语音识别/语音合成，不同的供应商支持的模型种类不一样，详情见：[模型管理 ](./user_manual/model/model.md)
     * 基础模型：模型名称，选项中显示执行模型类型的部分模型名称，支持自定义输入官方模型。
             注意自定义基础模型名称需保证与供应商平台的模型名称一致才能校验通过。   
-    * API Key 和 Secret Key：在供应商智能平台中创建应用的API Key 和 Secret Key，不同的平台参数要求不同。
+    * API Key 和 Secret Key：在供应商智能平台中创建应用的API Key 和 Secret Key。
 
 !!! Abstract ""
     以通义千问为例，配置如下，其它模型配置添加详情见：[模型管理-添加模型 ](./user_manual/model/model.md)
@@ -37,12 +36,12 @@
 !!! Abstract ""
     上传文档要求：  
 
-    * 文本文件:：Markdown、TXT、PDF、DOCX、HTML；
-    * 表格：Excel、CSV;
+    * 文件格式：Markdown、TXT、PDF、DOCX、HTML；
+    * 表格格式：Excel、CSV;
     * QA 问答对：Excel、CSV；  
     * 每次最多上传 50 个文件；   
     * 每个文件不超过 100 MB；
-    * 支持选择文件夹，上传文件夹下符合要求的文件。
+    * 支持选择文件夹，上传文件夹下符合格式要求的文件。
 
     文档规范建议：
 
@@ -54,19 +53,19 @@
 ### 3.2 设置分段规则
 
 !!! Abstract ""
-    目前 MaxKB 支持智能分段以及高级分段两种分段方式。
+    目前 MaxKB 支持智能分段和高级分段两种分段方式。
 
     **智能分段**
 
     （1）MarkDown 类型的文件智能分段规则：<br />
 
-    * 根据标题逐级下钻式分段（最多支持 6 级标题），每段的字符数最大为 4096 个字符；   
+    * 根据标题逐级下钻式分段，最多支持 6 级标题，每段的字符数最大为 4096 个字符；   
     * 当最后一级的文本段落字符数超过设置的分段长度时，会查找分段长度以内的回车进行截取。
 
     （2）HTML、DOCX 类型的智能分段规则：
 
     * 识别标题格式转换成 markdown 的标题样式；
-    * 逐级下钻进行分段（最多支持 6 级标题）每段的字符数最大为 4096 个字符。
+    * 逐级下钻进行分段，最多支持 6 级标题，每段的字符数最大为 4096 个字符。
 
     （3）TXT和 PDF 类型的文件智能分段规则：