KagTest 的安装和配置教程

1、项目的基础介绍和主要的编程语言

KagTest 是一个开源框架，旨在利用知识图谱和向量检索的优势来增强大型语言模型和知识图谱，以解决检索增强生成（RAG）技术中的挑战。该项目的主要编程语言是 Python，它是一种广泛使用的高级编程语言，易于学习和使用。

2、项目使用的关键技术和框架

KagTest 使用了以下关键技术和框架：

• OpenSPG: OpenSPG 是一个基于 SPG（Semantic-enhanced Programmable Graph）框架研发的知识图谱引擎，由蚂蚁集团和 OpenKG 联合推出。它能够构建和应用知识图谱，并提供相关服务。
• KAG (Knowledge Augmented Generation): KAG 是 OpenSPG 发布 v0.5 版本中推出的知识增强生成框架，旨在解决 RAG 技术中的挑战，例如向量相似度与知识推理相关性差距大、对知识逻辑不敏感等问题。

3、项目安装和配置的准备工作和详细的安装步骤

3.1 准备工作

在安装 KagTest 之前，请确保您已经安装了以下依赖项：

• Python 3.8 或更高版本: KagTest 需要 Python 3.8 或更高版本。
• Git: 用于克隆 KagTest 项目的代码库。
• Docker: 用于部署 OpenSPG-Server。

3.2 安装步骤

1. 克隆项目代码库

   使用以下命令克隆 KagTest 项目的代码库：

   git clone https://github.com/NanGePlus/KagTest.git
   cd KagTest
   

2. 安装依赖项

   在 KagTest 项目目录中，运行以下命令安装项目所需的依赖项：

   pip install -e .
   

   确认安装成功后，可以运行以下命令验证：

   knext --version
   

3. 配置项目

   在 KagTest 项目目录中，将 other/config 目录下的 example.cfg 文件复制到根目录，并根据您的业务需求修改配置参数，例如命名空间、嵌入和 LLM 配置参数。

4. 初始化项目

   在命令行中，运行以下命令初始化项目：

   knext project create --config_path ./example.cfg
   

   初始化项目完成后，进入对应的项目文件夹，并根据实际业务需求调整 schema，调整完成后执行 knext schema commit 命令提交 schema。

5. 构建索引

   将文档复制到项目文件夹中的 builder/data 目录下，支持 txt、pdf、markdown、docx、json 和 csv 等文件格式。然后，进入项目文件夹的 builder 目录，运行 python indexer.py 命令开始构建索引。

6. 检索

   构建索引成功后，您可以登录到 http://127.0.0.1:8887/ 或 http://127.0.0.1:7474/browser/ 查看知识图谱。图数据库的账号和密码分别为 neo4j 和 neo4j@openspg。

   接下来，进入项目文件夹的 solver 目录，运行 python query.py 命令开始检索。根据您的业务需求，您可以设置相关的 prompt 内容，例如 logic_form_plan.py、question_ner.py 和 resp_generator.py。

   您也可以在产品端进行测试，访问 http://127.0.0.1:8887/。

至此，您已完成 KagTest 的安装和配置。祝您使用愉快！