跳至内容
第一次运行 GraphRAG

第一次运行 GraphRAG

第一次运行时使用少量公开文本。确认配置、费用和输出都符合预期后,再处理自己的数据。

开始前,请先完成安装 GraphRAG,并激活安装 GraphRAG 的 Python 环境。下面的命令都在一个单独的 GraphRAG 项目目录中执行;先进入该目录,再初始化项目、配置模型和准备样本。

1. 初始化项目

graphrag init

按提示选择默认聊天模型和嵌入模型。命令会生成:

  • .env:保存 GRAPHRAG_API_KEY 等环境变量;
  • settings.yaml:索引和查询配置;
  • input/:待处理文本目录。

索引前先在 .env 和 settings.yaml 中完成模型与凭据配置。不要把 .env 或实际密钥提交到 Git。

2. 准备小型样本

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

这个学习示例使用 Project Gutenberg 提供的《圣诞颂歌》公开文本。确认 input/book.txt 已下载且不是错误页面,再开始索引。如果使用 Azure OpenAI,还要在 settings.yaml 的 models: 下配置 Provider、部署名、端点和 API 版本。

3. 先校验,再索引

graphrag index --dry-run
graphrag index

索引成功后,output/ 中会出现 Parquet 文件。若 --dry-run 已失败,不要直接开始付费索引;先修正模型、密钥或路径配置。

4. 执行查询

先用 Global 查询整篇故事的主题:

graphrag query "What are the top themes in this story?"

再用 Local 查询具体人物及其关系:

graphrag query \
  "Who is Scrooge and what are his main relationships?" \
  --method local

回到原文检查答案

查询完成后,检查索引产物和答案的原文依据:

  1. graphrag index --dry-run 无配置错误;
  2. graphrag index 生成 output/ 和 Parquet 文件;
  3. Global 与 Local 查询都返回与样本文本相关的内容;
  4. 根据答案中的主题、人物和关系,在 input/book.txt 中搜索关键词并阅读相邻段落,确认答案能够回到原文,而不是只看生成文本是否流畅。

此示例尚未独立实测,暂无实测输出、费用或耗时数据。实际回答会随模型和配置而变化。

遇到问题可查看GraphRAG 索引失败怎么办?,或继续了解常用命令。

最后更新于