系统模块设计手册

登录模块

1. 概述

• 目的: 提供用户身份验证功能，确保系统的安全性。
• 作用: 作为用户进入系统的入口，确保只有授权用户可以访问系统资源。

2. 功能需求

• 用户登录

  • 描述：用户可以通过手机号验证码或钉钉扫码进行登录。
  • 需求：支持手机号验证码登录和钉钉扫码登录。

• 手机号验证码登录

  • 描述：用户输入手机号并接收验证码进行登录。
  • 需求：系统应发送验证码到用户的手机号，并验证用户输入的验证码。

• 钉钉扫码登录

  • 描述：用户通过钉钉应用扫描二维码进行登录。
  • 需求：系统应生成二维码供用户扫描，并通过钉钉接口验证用户身份。

3. 系统架构

• 架构图

  

• 模块交互

  • 登录模块与用户数据库交互以验证用户身份。
  • 登录模块与短信服务交互以发送和验证手机号验证码。
  • 登录模块与钉钉接口交互以生成二维码并验证用户身份。

4. 用户界面设计

• 界面描述
  • 登录页面：

    • 包含手机号输入框和获取验证码按钮。

      

    • 包含钉钉扫码登录的二维码区域。

      

    • 包含登录按钮，用于提交验证码或完成扫码登录。

首页模块

1. 概述

• 目的: 提供用户进入系统后的主要信息展示和导航功能。
• 作用: 作为用户访问系统的起始页面，提供重要信息概览和快捷导航。

2. 功能需求

• AI知识库搜索

  • 描述：提供AI知识库的搜索功能。
  • 需求：支持用户输入关键词进行搜索，并返回相关知识条目。

• 我的工作

  • 描述：展示用户的最近访问、最近编辑和我的收藏。
  • 需求：动态更新用户的工作记录，支持快速访问。

• 知识仓库列表

  • 描述：展示系统中的知识仓库列表。
  • 需求：支持按类别或标签筛选知识仓库。

• 通知公告

  • 描述：显示系统的通知和公告。
  • 需求：支持实时推送和查看历史公告。

3. 系统架构

• 架构图

  

• 模块交互

  • 首页模块在单体服务中与用户数据模块交互以获取用户个性化信息。
  • 首页模块与知识库模块交互以提供搜索和列表功能。
  • 首页模块与公告模块交互以获取最新系统公告。
  • 首页模块与通知模块交互以接收和展示实时通知。

4. 用户界面设计

• 界面描述
  • 首页页面：

    • 包含AI知识库搜索框。

    • 包含我的工作区域，展示最近访问、最近编辑和我的收藏。

    • 包含知识仓库列表区域。

    • 包含通知公告区域。

      

知识仓库模块

1. 概述

• 目的: 提供用户对知识仓库的访问和管理功能。
• 作用: 允许用户查看和管理知识仓库中的内容，支持多种视图选项。

2. 功能需求

• 知识仓库列表

  • 描述：展示系统中的知识仓库列表。
  • 需求：支持按全部、最近访问、最近编辑和我的收藏进行筛选。

• 筛选功能

  • 描述：用户可以选择不同的视图选项来查看知识仓库。
  • 需求：提供筛选选项以便用户选择查看全部、最近访问、最近编辑或我的收藏。

3. 系统架构

• 架构图

  

• 模块交互

  • 知识仓库模块与用户数据模块交互以获取用户的访问和编辑记录。
  • 知识仓库模块与收藏模块交互以获取用户的收藏列表。

4. 用户界面设计

• 界面描述
  • 知识仓库页面：

    • 包含知识仓库列表展示区域。

      

百科词条模块

1. 概述

• 目的: 提供用户对百科词条的访问和管理功能。
• 作用: 允许用户查看、创建和管理百科词条，支持多种视图和操作。

2. 功能需求

• 词条分类

  • 描述：展示词条的分类列表。
  • 需求：支持按分类查看词条。

• 置顶词条

  • 描述：展示置顶的词条。
  • 需求：支持管理员设置和取消置顶。

• 词条列表

  • 描述：展示系统中的词条列表。
  • 需求：支持按分类、推荐、热门等筛选词条。

• 新建词条

  • 描述：用户可以创建新的词条。
  • 需求：支持词条的标题、内容、分类等信息的输入。

• 推荐词条

  • 描述：展示推荐的词条。
  • 需求：支持根据用户兴趣或系统推荐算法展示。

• 热门词条

  • 描述：展示当前热门的词条。
  • 需求：支持按浏览量或其他指标排序。

• 词条详情页

  • 描述：展示词条的详细信息。
  • 需求：支持查看词条的内容、分类、相关词条等信息。

3. 系统架构

• 架构图

  

• 模块交互

  • 百科词条模块与分类模块交互以获取词条分类信息。
  • 百科词条模块与推荐系统交互以获取推荐词条。
  • 百科词条模块与置顶词条管理交互以展示置顶词条。
  • 百科词条模块与热门词条管理交互以展示热门词条。
  • 百科词条模块与词条创建管理交互以支持新建词条。
  • 百科词条模块与词条详情管理交互以支持查看词条详情。

4. 用户界面设计

• 界面描述

  • 词条分类页面：

    • 包含词条分类列表。

    • 展示置顶词条。

    • 包含词条列表和筛选选项。

      

  • 推荐词条区域：

    • 展示推荐词条。

  • 热门词条区域：

    • 展示热门词条。

      

  • 新建词条页面：

    • 包含词条信息输入表单。

      

智能问答模块

1. 概述

• 目的: 提供用户对智能问答的访问和管理功能。
• 作用: 允许用户查看和管理智能问答，支持多种视图和操作。

2. 功能需求

• 新增对话

  • 描述：用户可以发起新的问答对话。
  • 需求：支持用户输入问题并获取智能回答。

• 选择知识库

  • 描述：用户可以选择不同的知识库进行问答。
  • 需求：提供知识库列表供用户选择，以便获取相关领域的回答。

• 展示历史会话

  • 描述：展示用户的历史问答会话。
  • 需求：支持查看过去的对话记录，包括问题和回答。

• 知识库问答对话

  • 描述：用户与AI进行对话，AI根据知识库内容提供回答。
  • 需求：支持实时对话，AI生成并返回智能回答。

3. 系统架构

• 架构图

  

• 模块交互

  • 智能问答模块与知识库模块交互以获取相关知识库内容。
  • 智能问答模块与AI问答引擎交互以生成并返回智能回答。
  • 智能问答模块与用户数据模块交互以管理和展示历史会话。

4. 用户界面设计

• 界面描述
  • 知识库问答页面：

    • 支持新建对话、获取知识库列表、选择知识库、查看知识更新时间和历史会话。

      

翻译模块

1. 概述

• 目的: 提供用户对多语言文件的翻译功能。
• 作用: 允许用户上传文件进行翻译，并管理翻译历史记录。

2. 功能需求

• 语言选择

  • 描述：用户可以选择源语言和目标语言。
  • 需求：支持200+种语言的互译。

• 文件上传

  • 描述：用户可以上传需要翻译的文件。
  • 需求：支持Word、PPT、Excel、HTML、XML、TXT、PDF等格式的文件上传。

• 历史记录展示

  • 描述：展示用户的翻译历史记录。
  • 需求：支持查看和管理历史记录，点击源文件或翻译文件即可下载到本地。

3. 系统架构

• 架构图

  

• 模块交互

  • 翻译模块与语言识别模块交互以确定源语言。
  • 翻译模块与翻译引擎交互以进行文件翻译。
  • 翻译模块与用户数据模块交互以管理和展示历史记录。

4. 用户界面设计

• 界面描述
  • 翻译页面：

    • 包含源语言和目标语言选择器。

    • 包含文件上传区域，支持多种格式。

    • 包含历史记录展示区域，支持下载源文件和翻译文件。

      

翻译管理模块

1. 概述

• 目的: 提供管理员对翻译记录的管理功能。
• 作用: 允许管理员查看、删除翻译记录，并支持文件下载。

2. 功能需求

• 翻译列表展示

  • 描述：展示系统中的翻译记录列表。
  • 需求：展示所有翻译记录，支持查看详细信息。

• 记录删除

  • 描述：管理员可以删除不需要的翻译记录。
  • 需求：支持单条记录删除。

• 文件下载

  • 描述：管理员可以下载翻译记录中的源文件和翻译文件。
  • 需求：支持点击表单中的文件链接进行下载。

3. 系统架构

• 架构图

  

• 模块交互

  • 翻译后台管理模块与用户数据模块交互以获取翻译记录。
  • 翻译后台管理模块与文件存储模块交互以进行文件下载。

4. 用户界面设计

• 界面描述
  • 翻译管理页面：

    • 包含翻译记录列表，支持筛选和删除操作。

    • 支持点击源文件和翻译文件进行下载。

      

词条管理模块

1. 概述

• 目的: 提供管理员对百科词条的管理功能。
• 作用: 允许管理员查看、编辑和删除词条，并管理标签和分类。

2. 功能需求

• 词条列表展示

  • 描述：展示系统中的词条列表。
  • 需求：支持查看词条的详细信息。

• 编辑词条

  • 描述：管理员可以编辑词条内容。
  • 需求：支持修改词条的标题、内容、封面、是否置顶、是否推荐、分类和标签。

• 删除词条

  • 描述：管理员可以删除不需要的词条。
  • 需求：支持单条词条删除。

• 标签管理

  • 描述：查看和管理词条标签。
  • 需求：支持编辑和删除标签。

• 分类管理

  • 描述：查看和管理词条分类。
  • 需求：支持编辑和删除分类。

3. 系统架构

• 架构图

  

• 模块交互

  • 词条管理模块与词条数据库交互以获取和管理词条信息。
  • 词条管理模块与标签管理模块交互以管理标签。
  • 词条管理模块与分类管理模块交互以管理分类。

4. 用户界面设计

• 界面描述

  • 词条管理页面：

    • 包含词条列表，支持编辑和删除操作。

      

  • 标签管理页面：

    • 支持查看、编辑和删除标签。

      

  • 分类管理页面：

    • 支持查看、编辑和删除分类。

      

表单管理模块

1. 概述

• 目的: 提供用户自定义表单的创建和管理功能。
• 作用: 允许用户创建自定义表单，并在创建工作流时选择使用。

2. 功能需求

• 自定义表单创建

  • 描述：用户可以创建新的自定义表单。
  • 需求：支持表单字段的添加、编辑和删除。

• 表单列表展示

  • 描述：展示系统中的自定义表单列表。
  • 需求：支持查看表单的详细信息。

• 表单选择

  • 描述：在创建工作流时，用户可以选择已有的自定义表单。
  • 需求：支持在工作流创建界面中选择并关联自定义表单。

3. 系统架构

• 架构图

  

• 模块交互

  • 表单管理模块与工作流模块交互以提供表单选择功能。
  • 表单管理模块与数据库交互以存储和管理表单信息。

工作流模块

1. 概述

• 目的: 提供用户创建和管理工作流的功能。
• 作用: 允许用户定义业务流程，自动化任务执行，并与其他模块进行集成。

2. 功能需求

• 工作流创建

  • 描述：用户可以创建新的工作流。
  • 需求：支持定义工作流的步骤、条件和触发器。

• 工作流编辑

  • 描述：用户可以编辑已有的工作流。
  • 需求：支持修改工作流的步骤、条件和触发器。

• 工作流执行

  • 描述：系统可以自动执行定义的工作流。
  • 需求：支持根据触发条件自动启动工作流，并执行各步骤。

• 表单选择

  • 描述：在创建或编辑工作流时，用户可以选择关联的自定义表单。
  • 需求：支持从表单管理模块中选择已有的自定义表单。

• 知识库选择

  • 描述：在创建或编辑工作流时，用户可以选择关联的知识库。
  • 需求：支持从知识库模块中选择相关知识库。

• 审批类型工作流

  • 描述：工作流类型为审批时，涉及用户审批的步骤。
  • 需求：支持审批流程的定义、查看、审批和拒绝操作。

• 任务类型工作流

  • 描述：工作流类型为任务时，涉及用户执行的任务。
  • 需求：
    • 支持任务的分配、执行、状态查看和进度跟踪。
    • 任务跨度：按天计算任务的持续时间。
    • 开始日期：任务的计划开始日期。
    • 任务开始日期：实际任务开始日期。
    • 执行日期：任务的计划执行日期。
    • 任务执行日期：实际任务执行日期。
    • 开始时间：任务的计划开始时间。
    • 任务开始时间：实际任务开始时间。
    • 结束时间：任务的计划结束时间。
    • 任务结束时间：实际任务结束时间。
    • 迟到提交：允许任务结束后多少分钟内提交，正整数，为空则不允许迟到。
    • 任务提醒：设置任务提醒时间。

3. 系统架构

• 架构图

  

• 模块交互

  • 工作流模块与表单管理模块交互以获取和选择自定义表单。
  • 工作流模块与知识库模块交互以选择相关知识库。
  • 工作流模块与任务执行引擎交互以执行工作流步骤。
  • 工作流模块与日志模块交互以记录和查看工作流执行日志。
  • 工作流模块与用户数据模块交互以管理审批和任务列表。

引擎管理模块

1. 概述

• 目的: 提供管理员对引擎的管理功能。
• 作用: 允许管理员新增、查看、编辑和删除引擎，并管理引擎的配置，特别是用于配置大模型的密钥，以支持知识库问答功能。

2. 功能需求

• 引擎列表展示

  • 描述：展示系统中的引擎列表。
  • 需求：支持查看引擎的详细信息，包括大模型的密钥配置。

• 引擎新增

  • 描述：管理员可以新增引擎。
  • 需求：支持新增引擎，包括大模型的密钥配置。

• 引擎编辑

  • 描述：管理员可以编辑引擎。
  • 需求：支持编辑引擎，包括大模型的密钥配置。

• 引擎删除

  • 描述：管理员可以删除引擎。
  • 需求：支持删除引擎。

3. 系统架构

• 架构图

  

应用管理模块

1. 概述

• 目的: 提供用户创建和管理应用的功能。
• 作用: 允许用户定义应用的基本信息和配置，以便与知识库和引擎进行集成。

2. 功能需求

• 新建应用
  • 描述：用户可以创建新的应用。
  • 需求：
    • 应用名称: 输入应用的名称。
    • 应用描述: 输入应用的描述。
    • Prompt: 输入应用的Prompt。
    • 关联知识库: 选择关联的知识库。
    • 选择引擎: 选择使用的引擎。
    • 对话模型: 选择对话模型。
    • 关联ID: 输入关联ID。
    • 回答风格: 选择回答风格（如严谨）。
    • Max Token: 设置最大Token数量。

3. 系统架构

• 架构图

  

• 模块交互

  • 应用管理模块与知识库模块交互以获取和选择关联的知识库。
  • 应用管理模块与引擎管理模块交互以选择合适的引擎。
  • 应用管理模块与对话模型模块交互以配置对话模型。

知识库模块

1. 概述

• 目的: 提供用户对知识库的访问和管理功能。
• 作用: 允许用户查看和管理知识库中的内容，支持多种视图选项。

2. 功能需求

• 新增知识库

  • 描述：用户可以创建新的知识库。
  • 需求：
    • 知识库名称: 输入知识库的名称。
    • 切片长度: 输入知识库的切片长度。
    • 上级目录: 选择知识库的上级目录。
    • 本地路径: 输入知识库的本地路径。
    • 选择引擎: 选择使用的引擎。
    • 查看角色: 设置可以查看知识库的角色。
    • 知识库简介: 输入知识库的简介内容。
    • 知识库封面: 上传知识库的封面图片。

• 知识库列表

  • 描述：展示系统中的知识库列表。
  • 需求：支持按全部、最近访问、最近编辑和我的收藏进行筛选。

• 筛选功能

  • 描述：用户可以选择不同的视图选项来查看知识库。
  • 需求：提供筛选选项以便用户选择查看全部、最近访问、最近编辑或我的收藏。

• 查看钉盘

  • 描述：用户可以查看同步到服务器本地中的钉盘文件和同步失败的文件。
  • 需求：支持重新下载同步失败的文件。

• 同步钉盘数据

  • 描述：将本地存储的文件同步到远程AI系统中。
  • 需求：
    • 数据上传: 同步本地路径下的文件到远程AI系统。
    • 数据更新: 确保本地文件及时更新到远程AI中。
    • 自动化流程: 自动识别并同步相关文件。
    • 实时同步: 提升数据管理效率。

3. 文件管理

• 上传文件

  • 描述：用户可以单独上传知识库文件到远程AI系统中。
  • 需求：支持选择文件上传，并查看文件列表和详情。

• 刷新关联ID

  • 描述：确保上传的文件与正确的AI模型或应用保持关联。
  • 需求：刷新关联ID以确保模型访问最新数据。

• 删除文件

  • 描述：用户可以删除不再需要的文件。
  • 需求：保持系统整洁和高效。

• 查看远程

  • 描述：查看远程AI系统中的文件列表。
  • 需求：支持删除不再需要的文件。

4. 系统架构

• 架构图