文档优化

Author: Andyguo5891

docs/img/model/maxkb_flow.png

@@ -1,35 +1,37 @@
 
-## 1 登录 MaxKB 系统
+## 1 操作流程
 
 !!! Abstract ""
-    使用浏览器打开服务地址：http://目标服务器IP地址:目标端口。   
-    内置用户名：admin    
-    默认密码：MaxKB@123.. 
+    MaxKB 的使用操作流程一般可分为四步：添加模型、创建知识库、创建应用、发布应用。     
+    在高级编排应用中还可以通过函数库的功能，创建数据处理、逻辑判断、信息提取或者其他满足工作场景的函数脚本，提供更加强大、灵活的能力。
 
-## 2 添加模型
+![通义千问 APIkey](img/model/maxkb_flow.png)
 
 !!! Abstract ""
-    登录 MaxKB 系统后，可以在【系统管理-模型设置】中添加模型，也可以在创建应用时再添加模型。
-    在供应商列表中选择指定供应商，然后点击【添加模型】，进入模型配置表单，不同的平台参数要求不同，基本配置参数如下：
+    下面通过同义千问大语言模型，以通用知识库为例，快速创建智能问答应用并发布。
 
-    * 模型名称：MaxKB 中自定义的模型名称。   
-    * 模型类型：包括大语言模型/向量模型/语音识别/语音合成，不同的供应商支持的模型种类不一样，详情见：[模型管理 ](./user_manual/model/model.md)
-    * 基础模型：模型名称，选项中显示执行模型类型的部分模型名称，支持自定义输入官方模型。
-            注意自定义基础模型名称需保证与供应商平台的模型名称一致才能校验通过。   
-    * API Key 和 Secret Key：在供应商智能平台中创建应用的API Key 和 Secret Key。
+## 2 添加模型
 
 !!! Abstract ""
-    以通义千问为例，配置如下，其它模型配置添加详情见：[模型管理-添加模型 ](./user_manual/model/model.md)
+    登录 MaxKB 系统后，在供应商列表中选择`同义千问`，然后点击【添加模型】，进入模型配置表单配置参数如下：
+
+    * 模型名称：MaxKB 中自定义的模型名称。  
+    * 权限：分为私有和公用两种权限，私有模型仅当前用户可用，公用模型即系统内所有用户均可使用，但其它用户不能编辑和删除。   
+    * 模型类型：大语言模型。   
+    * 基础模型：通义千问支持的 LLM 模型名称，下拉选项是常用的一些大语言模型名称，支持自定义输入。        
+    * API Key：阿里云 DashScope灵积模型服务 API Key管理中创建和查看。
 
 ![通义千问 APIkey](img/model/tongyi_model.png)
 
+!!! Abstract ""
+    不同的平台参数要求不同，其它供应商模型配置添加详情见：[模型管理-添加模型 ](./user_manual/model/model.md)
+
 
 ## 3 创建知识库
 
 !!! Abstract ""
 
-    打开【知识库】页面，点击【创建知识库】，进入创建知识库页面。<br />
-    以通用知识库为例说明支持库创建过程。先输入知识库名称、知识库描述、选择通用型知识库类型，然后将离线文档通过拖拽方式或选择文件上传方式进行上传。 
+    打开【知识库】页面，点击【创建知识库】，输入知识库名称、知识库描述、选择通用型知识库类型，然后将离线文档通过拖拽方式或选择文件上传方式进行上传。 
 
 ### 3.1 上传文档
 
@@ -98,13 +100,13 @@
 ![分段预览](<img/dataset/preview_segmentation.png>)
 
 !!! Abstract ""
-    用户可在分段预览中对不合理的分段进行再次编辑。
+    可在分段预览中对不合理的分段进行再次编辑。
 
 ![编辑分段](img/dataset/view_edit.png)
 
 
 !!! Abstract ""
-    点击【创建并导入】后，系统会对文档进行自动分段 -> 存储 -> 向量化处理操作，最终在知识库的文档列表中各个文件状态都为 `成功`。
+    点击【创建并导入】后，系统后台会对文档进行自动分段 -> 存储 -> 向量化处理操作，执行完成后在知识库文档列表中各个文件状态显示为`成功`。
 
 ![文档列表](img/dataset/doc_list.png)
 
@@ -121,53 +123,60 @@
     * 应用名称：用户提问时对话框的标题和名字。    
     * 应用描述：对应用场景及用途的描述。    
     * AI模型：在【系统设置】-【模型管理】中添加的大语言模型。    
-    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，可以引导大模型聊天方向.
-    * 多轮对话：开启后当用户提问时，将携带用户在当前会话中最后3个问题；不开启则仅向大模型提交当前问题。           
-    * 关联知识库：用户提问后会在关联的知识库中检索分段。   
-    * 开场白：用户打开对话时，系统弹出的问候语。支持 Markdown 格式；[-]后的内容为快捷问题，一行一个。       
-    * 问题优化：对用户提出的问题先进行一次 LLM 优化处理，将优化后的问题在知识库中进行向量化检索；开启后能提高检索知识库的准确度，但由于多一次询问大模型会增加回答问题的时长。
+    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，可以引导大模型聊天方向。可以对无引用知识库和引用知识库两种情况分别设置不同的提示词。
+    * 历史聊天记录：大模型提交当前会话中最后 N 条对话内容，否则仅向大模型提交当前问题。
+    * 关联知识库：用户提问后将在关联的知识库中检索分段。   
+    * 开场白：用户打开对话时，系统弹出的问候语。支持 Markdown 格式；[-]后的内容为快捷问题，一行一个。 
+    * 语音输入：开启后将支持语音方式进行提问，需要语音识别模型支持。
+    * 语音播放：开启后可以通过语音进行播放回答，可以通过浏览器播放，也可以通选择语音合成模型。
 
     应用信息设置完成后，可以在右侧调试预览中进行提问预览，调试预览中提问内容不计入对话日志。
 ![应用设置](img/app/app_setting.png)
 
 
 
 !!! Abstract "" 
-    **参数设置详细说明**
+    **知识库参数设置详细说明**
+
+    （1）**检索模式**
 
-    （1）**检索模式**<br />
-    向量检索：使用向量模型通过向量距离计算与用户问题最相似的文本分段；        
-    全文检索：通过关键词检索，返回包含关键词最多的文本分段；           
-    混合检索：同时执行全文检索和向量检索，再进行重排序，从两类查询结果中选择匹配用户问题的最佳结果。    
+    * 向量检索：使用向量模型通过向量距离计算与用户问题最相似的文本分段；        
+    * 全文检索：通过关键词检索，返回包含关键词最多的文本分段；           
+    * 混合检索：同时执行全文检索和向量检索，再进行重排序，从两类查询结果中选择匹配用户问题的最佳结果。    
 
-    （2）**相似度**<br />
-    相似度越高代表问题和分段的相关性越强。 
+    （2）**相似度：** 相似度越高代表问题和分段的相关性越强。 
 
-    （3）**引用分段数**<br />
-    提问时按相似度携带 N 个分段生成提示词询问 LLM 模型。 
+    （3）**引用分段数：** 提问时按相似度携带 N 个分段生成提示词询问 LLM 模型。 
 
-    （4）**引用最大字符数**<br />
-    引用分段内容设置最大字符数，超过时则截断。     
+    （4）**引用最大字符数：** 引用分段内容设置最大字符数，超过时则截断。     
 
-    （5）**无引用知识库处理方式**<br />
-    继续提问：可以自定义设置提示词，需要有`{question}`用户问题的占位符，才会把用户问题发送给模型。       
-    指定回复内容：当没有命中知识库分段时可以指定回复内容。   
+    （5）**无引用知识库处理**
 
-![alt text](<img/app/app-parameter-setting.png>)
+    * 继续提问：可以自定义设置提示词，需要有`{question}`用户问题的占位符，才会把用户问题发送给模型。       
+    * 指定回复内容：当没有命中知识库分段时可以指定回复内容。   
+    
+    （6）**问题优化：** 开启后对用户提出的问题先进行一次 LLM 优化处理，将优化后的问题在知识库中进行向量化检索，能提高检索知识库的准确度，但由于多一次询问大模型会增加回答问题的时长。
 
-## 5 演示预览
+![应用知识库参数设置](<img/app/app-parameter-setting.png>)
 
 !!! Abstract "" 
-    在应用列表页面，在概览页面点击演示或在浏览器中复制公开访问链接进入问答页面进行提问。
+    经过调试后，保存设置并发布。在应用列表页面，在概览页面点击演示或在浏览器中复制公开访问链接进入问答页面进行提问。
 ![演示预览](img/app/app_view.png)
 
+## 5 应用集成
 
-## 6 对话日志
+!!! Abstract "" 
+    MaxKB 应用支持零编码快速嵌入第三方 Web系统。
+
+    在应用概览页面，点击【嵌入第三方】，可以复制全屏模式代码或浮窗模式代码嵌入到第三方系统中，嵌入完成后便可在第三方系统中进行问答。
+
+![嵌入第三方](<../../img/app/embed.png>)
 
 !!! Abstract "" 
-    在对话日志中记录了所有用户会话中的问答详情，包括用户对 AI 回答的反馈信息。  
-    MaxKB 运营人员可以通过查看对话日志和用户反馈及时优化和修正解答。
+    在专业版中，也可以接入企业微信、公众号、钉钉和飞书等应用，详细说明见：[X-Pack功能-应用接入 ](./user_manual/X-Pack/app.md)。
+
+    
+
 
-![修正答案](img/app/log_details_edit.png)
 
 

docs/quick_start.md

@@ -64,7 +64,7 @@ nav:
         - X-Pack功能: 
             - 用户管理: user_manual/X-Pack/user.md
             - 登录认证: user_manual/X-Pack/login_auth.md
-            - 应用接入: user_manual/X-Pack/app.md
+            - 应用接入: user_manual/X-Pack/app_integrate.md
             - 应用显示: user_manual/X-Pack/app_logo_settting.md
             - 身份验证: user_manual/X-Pack/app_auth.md
             - 系统API: user_manual/X-Pack/system_API.md