graphiti

环境要求

• Python 3.10 或更高版本
• 图数据库：Neo4j 5.26 / FalkorDB 1.1.2 / Kuzu 0.11.2（已弃用）/ Amazon Neptune + OpenSearch
• OpenAI API Key（默认使用 OpenAI 做 LLM 推理与向量嵌入）
• 可选：Google Gemini、Anthropic 或 Groq 的 API Key（用于替换 LLM 供应商）

安装与启动步骤

1. 1安装核心库

   用 pip 或 uv 安装 graphiti-core，这是 Graphiti 的 Python SDK。建议在虚拟环境中执行。

   pip install graphiti-core

   复制

2. 2安装图数据库扩展

   按你选用的后端安装对应 extra：FalkorDB、Kuzu 或 Amazon Neptune，不加 extra 则默认走 Neo4j。

   pip install graphiti-core[falkordb]

   复制

3. 3安装可选 LLM 供应商

   若不用 OpenAI，可安装 Anthropic、Groq、Gemini 等额外依赖，也可一次装多个。

   pip install graphiti-core[anthropic,groq,google-genai]

   复制

4. 4启动 FalkorDB 容器

   用 Docker 一行命令启动 FalkorDB，映射 6379（数据库）与 3000（界面）端口，适合快速试用。

   docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest

   复制

5. 5或用 Compose 启动服务

   在项目根目录执行 docker compose up 启动 Neo4j；改用 FalkorDB 时加 --profile falkordb。

   docker compose up
   docker compose --profile falkordb up

   复制

6. 6配置 API Key

   Graphiti 默认使用 OpenAI，需在环境变量中设置 OPENAI_API_KEY，否则初始化和摄入会失败。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

7. 7运行快速开始示例

   参照 examples/quickstart/README.md，依次完成连接数据库、初始化索引、写入 episode 与混合检索。

关键配置

如何确认成功

运行 examples/quickstart 示例，能成功连接数据库、初始化索引并完成写入与混合检索，即表示部署成功。

常见问题

注意事项

• Kuzu 已弃用且上游不再维护，安装 kuzu extra 会触发 DeprecationWarning，新项目请勿使用。
• FalkorDB 的独立 Docker 启动命令会映射 6379 与 3000 端口，端口被占用时需自行调整。
• 自定义数据库配置需实例化 driver 并通过 graph_driver 参数传给 Graphiti（v0.17.0 起支持）。
• 主要支持通过图数据库之上的混合检索与图遍历，数据库需为 README 列出的受支持版本（如 Neo4j 5.26、FalkorDB 1.1.2）。