快速开始使用 Fast GraphRAG

1. 项目目录结构及介绍

Fast GraphRAG 是一个基于 Python 的框架，它为构建可解释、高精度、由代理驱动的检索工作流程而设计。以下是项目的目录结构及其简要介绍：

fast-graphrag/
├── .github/              # GitHub 工作流和配置文件
├── .vscode/              # VSCode 项目配置文件
├── benchmarks/           # 性能测试和基准数据
├── examples/             # 使用示例和教程
├── fast_graphrag/        # 主程序代码和模块
├── tests/                # 测试代码和测试用例
├── .gitignore            # Git 忽略文件列表
├── CODE_OF_CONDUCT.md    # 项目行为准则
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # MIT 许可证文件
├── README.md             # 项目自述文件
├── banner.png            # 项目横幅图片
├── demo.gif              # 项目演示动画
├── mock_data.txt         # 模拟数据文件
└── poetry.lock           # Poetry 依赖管理文件

• .github/ 目录包含了 GitHub Actions 工作流文件，这些文件用于自动化项目的构建和测试流程。
• .vscode/ 目录包含了 Visual Studio Code 的项目配置。
• benchmarks/ 目录包含了性能测试的代码和数据。
• examples/ 目录提供了使用 Fast GraphRAG 的示例代码和教程。
• fast_graphrag/ 目录是 Fast GraphRAG 的核心代码库。
• tests/ 目录包含了 Fast GraphRAG 的单元测试和集成测试。
• 其余文件如 .gitignore、CODE_OF_CONDUCT.md、CONTRIBUTING.md、LICENSE、README.md、banner.png、demo.gif、mock_data.txt 和 poetry.lock 等文件分别是 Git 忽略规则、项目行为准则、贡献指南、项目许可证、项目自述、项目横幅、项目演示动画、模拟数据以及依赖管理文件。

2. 项目的启动文件介绍

Fast GraphRAG 的启动主要是通过 Python 脚本 fast_graphrag.py 文件来完成的。这个文件通常位于 fast_graphrag/ 目录下。以下是启动文件的基本结构：

# fast_graphrag.py 的基本结构
class GraphRAG:
    def __init__(self, ...):
        ...

    def insert(self, ...):
        ...

    def query(self, ...):
        ...

# 其他相关的方法和类

在具体使用时，你需要从 fast_graphrag.py 中导入 GraphRAG 类，并创建其实例。例如：

from fast_graphrag import GraphRAG
grag = GraphRAG(...)

3. 项目的配置文件介绍

Fast GraphRAG 的配置主要通过环境变量和配置文件进行。环境变量可以设置在 .env 文件中或直接在操作系统层面设置。以下是一些常见的配置选项：

• OPENAI_API_KEY: OpenAI API 的密钥，用于调用 OpenAI 的语言模型。
• CONCURRENT_TASK_LIMIT: 并发任务限制，用于控制同时处理的任务数量。

在 .env 文件中，你可以这样设置：

OPENAI_API_KEY=your_openai_api_key
CONCURRENT_TASK_LIMIT=8

在代码中，你可以通过 os 模块来读取这些环境变量：

import os
openai_api_key = os.getenv('OPENAI_API_KEY')
concurrent_task_limit = os.getenv('CONCURRENT_TASK_LIMIT', default=8)

以上是 Fast GraphRAG 的基本项目结构和启动文件、配置文件的介绍。你可以根据具体的使用场景和需求来调整这些配置。