graphrag get_started 入门指南

https://microsoft.github.io/graphrag/get_started/

入门指南

要求

• Python 3.10-3.12

要开始使用GraphRAG系统，您有几个选项：

👉 使用GraphRAG加速器解决方案
👉 从pypi安装。
👉 从源代码使用。

快速入门

我们推荐尝试GraphRAG加速器包，以快速开始使用GraphRAG系统。这提供了一个用户友好的端到端体验，使用Azure资源。

顶级模块

• 索引管道概述
• 查询引擎概述

概述

以下是一个简单的端到端示例，展示了如何使用GraphRAG系统来索引一些文本，然后使用索引数据来回答关于文档的问题。

安装GraphRAG

pip install graphrag

运行索引器

现在我们需要设置一个数据项目和一些初始配置。让我们来设置这些。我们使用默认配置模式，您可以根据需要使用配置文件（我们推荐）或环境变量进行自定义。

首先，让我们准备好一个示例数据集：

mkdir -p ./ragtest/input

现在，让我们从可信来源获取查尔斯·狄更斯的《圣诞颂歌》：

curl https://www.gutenberg.org/cache/epub/24022/pg24022.txt -o ./ragtest/input/book.txt

接下来，我们将注入一些必需的配置变量：

设置工作区变量

首先，确保设置所需的环境变量。有关这些环境变量的详细信息，以及可用的环境变量，请参阅变量文档。

要初始化您的工作区，首先运行graphrag.index --init命令。由于我们在上一步中已经配置了一个名为.ragtest的目录，我们可以运行以下命令：

python -m graphrag.index --init --root ./ragtest

这将在./ragtest目录中创建两个文件：.env和settings.yaml。

• .env包含运行GraphRAG管道所需的环境变量。如果您检查该文件，您会看到一个定义的环境变量GRAPHRAG_API_KEY=<API_KEY>。这是OpenAI API或Azure OpenAI端点的API密钥。您可以将其替换为您自己的API密钥。
• settings.yaml包含管道的设置。您可以修改此文件以更改管道的设置。

OpenAI和Azure OpenAI

要在OpenAI模式下运行，只需确保在.env文件中更新GRAPHRAG_API_KEY的值为您自己的OpenAI API密钥。

Azure OpenAI

此外，Azure OpenAI用户应在settings.yaml文件中设置以下变量。要找到适当的部分，只需搜索llm:配置，您应该会看到两个部分，一个用于聊天端点，一个用于嵌入端点。以下是如何配置聊天端点的示例：

type: azure_openai_chat # 或 azure_openai_embedding 用于嵌入
api_base: https://<instance>.openai.azure.com
api_version: 2024-02-15-preview # 您可以根据其他版本进行自定义
deployment_name: <azure_model_deployment_name>

有关配置GraphRAG的更多详细信息，请参阅配置文档。
要了解更多关于初始化的信息，请参阅初始化文档。
有关使用CLI的更多详细信息，请参阅CLI文档。

运行索引管道

最后，我们将运行管道！

python -m graphrag.index --root ./ragtest

此过程将需要一些时间运行。这取决于您的输入数据大小、使用的模型以及正在使用的文本块大小（这些可以在您的settings.yml文件中配置）。一旦管道完成，您应该会看到一个名为./ragtest/output/<timestamp>/artifacts的新文件夹，其中包含一系列parquet文件。

使用查询引擎

运行查询引擎
现在让我们使用此数据集提出一些问题。

以下是使用全局搜索提出高层问题的示例：

python -m graphrag.query \
--root ./ragtest \
--method global \
"What are the top themes in this story?"

以下是使用局部搜索提出关于特定角色的更具体问题的示例：

python -m graphrag.query \
--root ./ragtest \
--method local \
"Who is Scrooge, and what are his main relationships?"

请参阅查询引擎文档，了解如何在索引器完成执行后利用我们的本地和全局搜索机制从数据中提取有意义的见解的详细信息。