neo4j-graphrag-python

环境要求

• Python 3 环境（README 未指定具体版本）
• 可访问的 Neo4j 实例（本地或远程）
• 需要 OpenAI 相关功能时准备 OPENAI_API_KEY
• 如需参与开发，需安装 uv 依赖管理工具

安装与启动步骤

1. 1安装核心库

   使用 pip 安装 Neo4j 官方 GraphRAG 包的最新稳定版，这是使用本项目的必要前提。

   pip install neo4j-graphrag

   复制

2. 2安装OpenAI集成

   README 明确提示：运行示例代码需要安装 openai 依赖，通过方括号 extra 方式安装。

   pip install "neo4j_graphrag[openai]"

   复制

3. 3导出OpenAI密钥

   示例需要把 OpenAI 密钥导出为名为 OPENAI_API_KEY 的环境变量，供程序读取。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

4. 4填写Neo4j连接信息

   在脚本中修改 NEO4J_URI、NEO4J_USERNAME、NEO4J_PASSWORD 三个变量为你自己 Neo4j 实例的连接信息。

5. 5运行示例脚本

   确保 Neo4j 实例已启动后运行示例，把一段文本交给 kg_builder 构建知识图谱，最后关闭 driver。

   python your_script.py

   复制

6. 6开发模式安装

   若要参与项目开发，先克隆仓库，再用 uv 安装包含开发依赖在内的全部依赖。

   git clone https://github.com/neo4j/neo4j-graphrag-python.git
   cd neo4j-graphrag-python
   uv sync --group dev

   复制

关键配置

如何确认成功

示例脚本运行无报错，且能在 Neo4j 中查询到由输入文本抽取出的实体与关系图谱。

常见问题

注意事项

• README 未给出 Python 最低版本要求，请自行确认环境兼容性。
• 示例为异步调用（asyncio.run），需在脚本中以 asyncio 方式运行。
• 更多用法可参考官方文档和仓库 examples 目录中的示例。