跳到主要内容

Knowledge 模块配置与使用

配置文件 (modules/knowledge.yml)​

此文件用于定义和配置插件所使用的知识库。

knowledges​

  • 类型: 对象映射 (Map)
  • 必需: 是
  • 描述: 包含一个或多个知识库的定义。每个知识库都需要一个唯一的标识符作为键 (例如 默认知识库)。

知识库配置项​

对于 knowledges 下的每一个知识库 (例如 默认知识库):

  • name:
    • 类型: 字符串
    • 必需: 否
    • 描述: 知识库的友好显示名称。
    • 示例: 默认知识库123
  • description:
    • 类型: 字符串
    • 必需: 否
    • 描述: 对该知识库的简短描述。
    • 示例: 一个默认的知识库
  • embedding-model:
    • 类型: 字符串
    • 必需: 是
    • 描述: 指定该知识库在处理和检索时使用的嵌入模型。这个值必须是在 embedding.yml 文件中定义的某个嵌入模型的 ID。
    • 示例: siliconflow-bge-m3
  • sources:
    • 类型: 对象映射 (Map)
    • 必需: 是
    • 描述: 定义该知识库包含的一个或多个数据来源。每个来源都需要一个唯一的标识符作为键 (例如 QA本地知识库)。
知识源配置项​

对于 sources 下的每一个知识源 (例如 QA本地知识库):

  • type:
    • 类型: 字符串
    • 必需: 是
    • 描述: 指定知识源的类型。常见的类型可能包括：
      • file_system: 从本地文件系统加载文档。
      • (可能还有其他类型，如 web_url, database 等，具体支持类型需参考插件实现)
    • 示例: file_system
  • path: (通常用于 file_system 类型)
    • 类型: 字符串
    • 必需: 是 (对于 file_system 类型)
    • 描述: 指定知识源文件的路径。对于 file_system 类型，这通常是相对于插件数据文件夹 (plugins/Knowlith/) 的路径。
    • 示例: ./docs/default (表示加载 plugins/Knowlith/docs/default 目录下的所有支持的文件)
  • (其他可能的配置项): 根据 type 的不同，可能还需要其他配置项，例如 URL、数据库连接信息等。

示例配置​

knowledges:
  默认知识库:
    name: 默认知识库123
    description: 一个默认的知识库
    # 使用的嵌入模型
    embedding-model: siliconflow-bge-m3
    #一系列知识源
    sources:
      QA本地知识库:
        # 文件夹路径知识源
        type: file_system
        #插件文件夹/docs/default 路径下的
        path: ./docs/default

本页介绍 Knowlith 的 Knowledge (知识库) 模块。

(待补充)