开源项目启动和配置文档

原创于 2025-05-23 09:01:47 发布 · 278 阅读

CC 4.0 BY-SA版权

开源项目启动和配置文档

KagTest KAG开源框架介绍及使用KAG实现知识增强生成应用(产品模式测试、开发者模式测试)，KAG是OpenSPG发布v0.5版本中推出的知识增强生成（KAG）的专业领域知识服务框架，旨在充分利用知识图谱和向量检索的优势，增强大型语言模型和知识图谱，以解决 RAG 挑战项目地址: https://gitcode.com/gh_mirrors/ka/KagTest

1. 项目的目录结构及介绍

该项目包含了使用KAG框架进行知识增强生成应用的示例代码和配置文件。项目的目录结构如下：

README.md：项目说明文件，包含项目介绍、使用方法和相关链接。
LICENSE：项目许可文件，通常为MIT许可证。
docker-compose.yml：Docker Compose配置文件，用于部署OpenSPG-Server。
example.cfg：项目配置文件，包含项目初始化和运行所需的配置参数。
Demo：示例代码文件夹，包含用于功能测试的脚本文件。
- ner.py：命名实体识别脚本。
- std.py：标准化脚本。
- triple.py：三元组抽取脚本。
- indexer.py：构建索引脚本。
- query.py：检索脚本。
- logic_form_plan.py：逻辑形式规划脚本。
- question_ner.py：问题命名实体识别脚本。
- resp_generator.py：响应生成脚本。
other：其他配置文件夹，包含额外的配置文件。
- config：配置文件目录。
  - example.cfg：配置文件示例。

2. 项目的启动文件介绍

项目的启动文件主要包括docker-compose.yml和example.cfg。

docker-compose.yml：Docker Compose配置文件，用于部署OpenSPG-Server。运行以下命令启动OpenSPG-Server：

docker compose -f docker-compose.yml up -d

example.cfg：项目配置文件，包含项目初始化和运行所需的配置参数。需要根据实际业务需求修改配置参数，例如：

{
  "embedding": {
    "vectorizer": "kag.common.vectorizer.OpenAIVectorizer",
    "api_key": "你的API密钥",
    "vector_dimensions": 1536,
    "base_url": "你的API地址",
    "model": "text-embedding-ada-002"
  },
  "llm": {
    "api_key": "你的API密钥",
    "base_url": "你的API地址",
    "model": "gpt-4o-mini",
    "client_type": "maas"
  },
  "vector": {
    "vectorizer": "kag.common.vectorizer.OpenAIVectorizer",
    "api_key": "你的API密钥",
    "vector_dimensions": 1536,
    "base_url": "你的API地址",
    "model": "text-embedding-ada-002"
  },
  "prompt": {
    "biz_scene": "default",
    "language": "zh"
  }
}