更新 v1.8的内容以及调整模型模型结构

Author: Andyguo5891

docs/img/app/defult_workflow.png

@@ -1,6 +1,6 @@
 # 登录认证
 !!! Abstract "" 
-    MaxKB专业版已经支持LDAP、CAS、OIDC三种单点登录方式，以及企业微信、钉钉、飞书移动端扫码登录验证，满足企业对于强身份验证和访问控制的需求。
+    MaxKB专业版支持 LDAP、CAS、OIDC、OAUTH2 单点认证协议，以及企业微信、钉钉、飞书移动端扫码登录验证，满足企业对于强身份验证和访问控制的需求。
 
 ## 1 LDAP
 
@@ -25,9 +25,16 @@
     **说明：** OIDC 回调地址即 MaxKB 访问地址加上`/api/oidc`，例如：`http://40.100.86.240:8080/api/oidc`
 ![OIDC](../../img/system/OIDC.png)
 
-## 4 扫描登录
+## 4 OAUTH2
 
-### 4.1 企业微信扫码登录
+!!! Abstract ""
+    配置 OAUTH2 的过程可参考下图（授权端以 github 为例），注意勾选下方"启用 OAHTU2 认证"后开启此功能。   
+    **说明：** OAUTH2 回调地址即 MaxKB 访问地址加上`/api/oauth2`，例如：`http://40.100.86.240:8080/api/oauth2`
+![OAHTU2](../../img/system/oauth2.png)
+
+## 5 扫描登录
+
+### 5.1 企业微信扫码登录
 
 !!! Abstract ""
     企业微信扫码登录配置参数说明：
@@ -60,7 +67,7 @@
     完成企业微信应用的配置和发布后，在 MaxKB 企业微信登录扫码配置页面配置相应信息并通过效验。
 ![企业微信配置](../../img/system/qiwei_setting.png)
 
-### 4.2 钉钉扫码登录
+### 5.2 钉钉扫码登录
 
 !!! Abstract ""
     钉钉扫码登录配置参数说明：
@@ -85,7 +92,7 @@
     完成配置后发布，然后在 MaxKB 钉钉扫码登录扫码配置页面进行配置并保存。
 ![钉钉创建应用](../../img/system/dingding_setting.png)
 
-### 4.3 飞书扫码登录
+### 5.3 飞书扫码登录
 
 !!! Abstract ""
     飞书扫码登录配置参数说明：
@@ -112,8 +119,8 @@
     第三步：发布应用。在【版本管理与发布】中，输入应用版本号、更新说明等信息，点击【保存】，完成应用发布。
 ![飞书发布应用](../../img/system/feishu_app_release.png)
 
-## 5 登陆认证
+## 6 登陆认证
 
 !!! Abstract ""
     完成认证信息配置后，在登陆页面点击选择对应的认证方式进行登陆。         
-![OIDC](../../img/system/auth_login.png)
+![登陆认证](../../img/system/auth_login.png)

docs/img/model/bailian_llm.png

@@ -0,0 +1,31 @@
+# 简单配置应用
+
+## 1 创建简易配置应用
+
+!!! Abstract ""
+    点击【创建应用】，输入应用名称以及应用描述，选择【简易配置】，点击【创建】，进入简易配置应用设置页面。
+
+![选择应用类型](../../img/app/selectAppType.png)
+
+!!! Abstract ""
+    左侧为应用信息，右侧为调试预览界面。   
+
+    * 应用名称：提问时对话框的标题和名字。
+    * 应用描述：对应用场景及用途的简要描述。
+    * AI模型：可选择在【系统设置】-【模型管理】中添加的大语言模型，也可直接添加。
+    * 角色设定：通过给模型指定一个特定的角色或身份，来指导模型的输出更加符合特定的场景或任务需求。
+    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，可以引导大模型聊天方向，该提示词会被固定在上下文的开头。可以使用变量，例如：{data} 是引用知识库中已知信息，{question}是用户提出的问题。目前可针对是否引用知识库设置不同的提示词。
+    * 历史聊天记录：大模型提交当前会话中最后 N 条对话内容，否则仅向大模型提交当前问题。
+    * 关联知识库：用户提问优先在关联的知识库中检索分段，引用分段生成提示词发送给大模型进行询问。若未关联知识库或未匹配到分段内容，则默认将用户问题发送给大模型进行询问。知识库可设置检索方式、知识库的相似度，引用分段数 Top-N 和最大引用字符数、无引用知识库分段时的回答策略以及是否进行问题优化等。
+    * 开场白：打开对话时，系统弹出的默认引导说明。支持 Markdown 格式，[-]后的内容为快捷问题，一行一个。
+    * 语音输入：在语音输入完成后会转化为文字后再发送提问，需要语音识别模型的支持。
+    * 语音播放：将大模型生成的回答内容转换为语音进行播放，需要语音合成模型的支持。
+
+
+!!! Abstract ""   
+    应用信息设置完成后，可在右侧调试预览中进行提问测试，调试过程不计入对话日志。</br>
+    点击【保存并发布】后，应用设置才生效。
+
+![应用设置](../../img/app/app_setting.png)
+
+

docs/img/model/hunyuan_vision.png

@@ -1,40 +1,6 @@
-# 应用
+# 高级编排应用
 
-!!! Abstract ""
-    应用是指基于 LLM 大语言模型构建的实际场景应用，分为简易配置和高级编排两种类型，并支持全屏模式和浮窗模式嵌入到第三方 Web 应用系统以及接入企业微信、钉钉、飞书、公众号等应用，满足各类发布需求。    
-    **友情提示：社区版支持应用的最大数量为 5。**       
-
-![Alt text](../../img/app/applist.png)
-
-## 1 创建简易配置应用
-
-!!! Abstract ""
-    点击【创建应用】，输入应用名称以及应用描述，选择【简易配置】，点击【创建】，进入简易配置应用设置页面。
-
-![选择应用类型](../../img/app/selectAppType.png)
-
-!!! Abstract ""
-    左侧为应用信息，右侧为调试预览界面。   
-
-    * 应用名称：提问时对话框的标题和名字。
-    * 应用描述：对应用场景及用途的简要描述。
-    * AI模型：可选择在【系统设置】-【模型管理】中添加的大语言模型，也可直接添加。
-    * 角色设定：通过给模型指定一个特定的角色或身份，来指导模型的输出更加符合特定的场景或任务需求。
-    * 提示词：系统默认有智能知识库的提示词，用户可以自定义通过调整提示词内容，可以引导大模型聊天方向，该提示词会被固定在上下文的开头。可以使用变量，例如：{data} 是引用知识库中已知信息，{question}是用户提出的问题。目前可针对是否引用知识库设置不同的提示词。
-    * 历史聊天记录：大模型提交当前会话中最后 N 条对话内容，否则仅向大模型提交当前问题。
-    * 关联知识库：用户提问优先在关联的知识库中检索分段，引用分段生成提示词发送给大模型进行询问。若未关联知识库或未匹配到分段内容，则默认将用户问题发送给大模型进行询问。知识库可设置检索方式、知识库的相似度，引用分段数 Top-N 和最大引用字符数、无引用知识库分段时的回答策略以及是否进行问题优化等。
-    * 开场白：打开对话时，系统弹出的默认引导说明。支持 Markdown 格式，[-]后的内容为快捷问题，一行一个。
-    * 语音输入：在语音输入完成后会转化为文字后再发送提问，需要语音识别模型的支持。
-    * 语音播放：将大模型生成的回答内容转换为语音进行播放，需要语音合成模型的支持。
-
-
-!!! Abstract ""   
-    应用信息设置完成后，可在右侧调试预览中进行提问测试，调试过程不计入对话日志。</br>
-    点击【保存并发布】后，应用设置才生效。
-
-![应用设置](../../img/app/app_setting.png)
-
-## 2 创建高级编排应用
+## 1 创建高级编排应用
 
 !!! Abstract ""
     点击【创建应用】，输入应用名称，选择【高级编排】，点击【创建】，进入工作流编排页面。
@@ -44,15 +10,19 @@
 !!! Abstract ""
     新创建的高级编排应用会默认生成简易工作流，可以根据自己的需求进行自定义编排，点击发布后生效。<br /> 
 
-    **注意：**<br />
+    **注意：**
 
     - 画布上的节点必须在工作流程中，不能有流程外的孤立节点，否则在发布时会校验失败。<br /> 
     - 每个节点可以根据节点的用途进行重命名，双击节点名称即可重命名，但同一个工作流编排中节点名称不能重复。<br /> 
     - 连线的后置节点可以引用前置节点的输出参数，如果节点名称变更，需要重新复制变量，参数引用方式是`{{节点名称.变量名称}}`。
 
+!!! Abstract "" 
+    完成工作流程设计之后，使用左下方的画布控制栏，可以对画布进行整体调整，包括画布缩放、节点收缩以及流程一键优化。
+
 ![默认画布](../../img/app/defult_workflow.png)
 
-### 2.1 添加组件
+### 1.1 基础组件
+
 
 !!! Abstract ""  
     每个工作流都有基本信息与开始两个基础节点：
@@ -73,13 +43,13 @@
 
 ![编排画布](../../img/app/workflow.png)
 
-#### 2.1.1 开始
+#### 1.1.1 开始
 
 !!! Abstract "" 
     节点说明：工作流的开始节点，有且唯一，不能删除和复制，问答页面输入的问题会作为该节点的输出参数{question}，后续节点如需引用可以复制输出参数或选择变量：`开始节点->用户问题`。
 ![开始节点](../../img/app/start.jpg)
 
-#### 2.1.2 知识库检索节点
+#### 1.1.2 知识库检索节点
 
 !!! Abstract "" 
     节点说明：如果应用需要关联知识库，则需要在编排中添加知识库检索节点，选择知识库、设置检索参数、选择检索的问题。
@@ -96,7 +66,7 @@
     * 检索结果 {data}：字符串类型，指根据检索问题、检索参数进行检索后命中的分段内容；       
     * 满足直接回答的分段内容 {directly_return}：字符串类型，指根据检索问题、检索参数进行检索后命中的分段中满足直接回答的所有分段内容。     
 
-#### 2.1.3 AI 对话节点
+#### 1.1.3 AI 对话节点
 
 !!! Abstract "" 
     节点说明：如果应用需要与AI大模型进行对话，则需要在编排中添加 AI 对话组件，选择 AI 模型，设置提示词，提示词可以引用前置节点的参数输出，如：可以引用前置知识库检索的检索结果和开始节点的问题变量。
@@ -108,7 +78,7 @@
 
     * AI回答内容 {answer}：AI模型返回的内容。   
 
-#### 2.1.3 指定回复节点
+#### 1.1.3 指定回复节点
 
 !!! Abstract "" 
     节点说明：指定输出文本内容，如没有在知识库查询到关联内容时，可以指定回复内容；支持指定输出变量，如在知识库查询到的相关内容满足直接回答的要求，可以直接选择该变量，系统会自动转化成字符串进行输出。
@@ -120,7 +90,7 @@
 
     * 内容{answer}： 指定回复输出的内容。   
 
-#### 2.1.4 判断器节点
+#### 1.1.4 判断器节点
 
 !!! Abstract "" 
     节点说明：根据不同的条件判断执行不同的分支，每个分支一个输出，每个分支必须有后置执行节点。  
@@ -132,7 +102,7 @@
 
     * 分支名称{branch_name}：根据条件判断执行分支的分支名称。
 
-#### 2.1.5 多路召回节点
+#### 1.1.5 多路召回节点
 
 !!! Abstract "" 
     节点说明：根据需要重排的内容、检索问题以及检索参数进行多路召回。 
@@ -143,57 +113,34 @@
     * 重排结果列表 {result_list}：数组类型，指根据重排后的结果列表。
     * 重排结果 {result}：字符串类型，指根据检索参数后的重排结果。
 
-
-### 2.2 使用场景举例
-
-!!! Abstract ""
-    (1) 问题分类回答：提出问题后，先对问题进行分类，然后按照问题类别查询不同的知识库。要求如下：
-
-    - 如果分类结果是打招呼，则指定回复内容；    
-    - 如果分类结果是售前问题咨询，则查询售前问题知识库；      
-    - 如果分类结果是售后问题咨询类，则查询售后问题知识库；     
-    - 如果分类结果是其它问题，则直接问 AI 模型。     
-    实现以上场景的工作流编排如下：
-
-![问题分类案例](../../img/app/question_classification.png)
+### 1.2 添加函数
 
 !!! Abstract "" 
-    (2) 敏感词检索：提出问题后，先判断用户的问题是否存在敏感词，如果存在敏感词，就指定回复的内容，如果不存在敏感词就继续检索知识库。   
-    要想实现该需求，需要执行以下几步：</br>
-    第一步：在知识库中维护一个敏感词知识库，把敏感词添加到问题中，然后关联一个指定敏感词的分段；
+    在高级编排流程中，可以添加函数库函数作为流程中的一个处理节点，以灵活处理复杂需求。
 
-![敏感词问题库](../../img/app/Sensitive.jpg)
+### 1.3 添加应用
 
 !!! Abstract "" 
-    第二步：在开始节点后，增加一个知识库检索节点命名为：敏感词检索，选择知识库：敏感词知识库；  
-![敏感词分段](../../img/app/Sensitive_segmentation.png)
-
-!!! Abstract ""
-    第三步：在知识库检索节点后，增加一个判断器，判断敏感词检索的检索结果是否存在敏感词，检索结果不为空，则说明存在敏感词，否则则不存在敏感词可以继续检索知识库，进行后续流程。
-  
-![敏感词编排](../../img/app/Sensitive_workflow.png)
-
+    在高级编排流程中，可以添加其它应用（简单配置应用和流程编排应用）作为流程中的一个处理节点，直接快速利用子应用的问答结果。
 
-### 2.3 调试
+### 1.4 调试
 
 !!! Abstract ""
-    点击【调试】后，先校验流程是否合规，校验通过后可在当前页面进行对话测试。
+    完成所有的编排设计后，可点击【调试】后，先校验流程是否合规，校验通过后可在当前页面进行对话测试。
 
 ![调试预览](../../img/app/workflow_view.png)
 
-### 2.4 执行详情
-
 !!! Abstract ""
     在调试对话框中进行提问，AI回答完成后，会显示【执行详情】，点击【执行详情】后，在弹出执行详情对话框中可以查看每个流程节点的执行状态、耗时以及其它执行信息。
 
 ![执行详情](../../img/app/exec_detail.png)
 
-### 2.5 保存
+### 1.5 保存
 
 !!! Abstract ""
     当前系统每隔 1 分钟自动保存到本地，发布成功后将配置同步到后台数据库。
 
-### 2.6 发布
+### 1.6 发布
 
 !!! Abstract ""    
     点击【发布】后会校验当前工作流是否符合规则，符合规则将成功发布，否则发布失败。发布成功后，所有节点配置修改才在问答页面中生效。