项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1034
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Python 3.10 或更高版本
- 已安装并运行 Docker
- 一个可用的 OpenAI API Key(sk- 开头)
- 本机 6379 与 3000 端口未被占用
安装与启动步骤
-
1检查 Python 版本
GraphRAG-SDK 要求 Python 3.10+,版本过低需先升级 Python 环境。
python --version -
2启动 FalkorDB
用 Docker 拉取并后台启动 FalkorDB 图数据库,同时映射图数据库端口和浏览器界面端口。
docker run -d -p 6379:6379 -p 3000:3000 --name falkordb falkordb/falkordb:latest -
3安装 SDK
通过 pip 安装 graphrag-sdk 及 litellm 扩展,litellm 用于对接大模型接口。
pip install graphrag-sdk[litellm] -
4安装 PDF 支持
若需要摄取 PDF 文档,改用 pdf 扩展安装;该扩展会在写入图库前清洗非法控制字符。
pip install graphrag-sdk[litellm,pdf] -
5配置 API Key
把 OpenAI API Key 写入环境变量,SDK 调用 LLM 时会读取它。请替换成你自己的真实密钥。
export OPENAI_API_KEY="sk-xxxxxxxx" -
6确认容器运行
查看 falkordb 容器是否处于 Up 状态,以及 6379、3000 两个端口是否已正确映射。
docker ps
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | 调用 LLM 所需的 OpenAI 密钥,SDK 从环境变量读取 | sk-xxxxxxxx |
6379 | 是 | FalkorDB 主服务端口,SDK 连接图数据库使用 | 6379:6379 |
3000 | 否 | FalkorDB 浏览器界面端口,用于可视化查看图谱 | 3000:3000 |
如何确认成功
执行 docker ps,看到名为 falkordb 的容器状态为 Up,且 6379、3000 端口处于映射状态,即表示环境就绪。
常见问题
Q:只装 graphrag-sdk 够用吗?
A:不够。README 的快速开始使用 pip install graphrag-sdk[litellm],需要带上 litellm 扩展才能对接大模型接口。
Q:要处理 PDF 文档怎么办?
A:把安装命令换成 pip install graphrag-sdk[litellm,pdf],该扩展会清洗 ID 和字符串属性中的非法控制字符,避免 FalkorDB 的 Cypher 解析报错。
Q:必须本地装 FalkorDB 吗?
A:README 直接给出 docker run 方式启动 falkordb/falkordb:latest 镜像,这是官方示例中最省事的做法。
Q:端口 6379 或 3000 被占用怎么办?
A:修改 docker run 中 -p 的宿主机端口映射,例如 -p 16379:6379,避免与已有的 Redis 等服务冲突。
注意事项
- 项目标注为早期阶段,接口可能变动,建议锁定安装版本。
- API Key 通过环境变量传入,不要写死在代码或提交到 Git 仓库。
- 容器名为 falkordb,重复创建前需先删除同名旧容器。
核心亮点
- 混合检索机制:融合向量相似度和图结构遍历,提升复杂关系问题的回答准确率
- 模块化设计:支持自定义图存储、向量库和 LLM 提供商,易于扩展和集成
- 面向生产:提供性能优化和可观测性接口,适合构建大规模 GenAI 应用
不足之处
- 项目早期,API 可能不稳定,文档和社区支持待观察
- 依赖图数据库和向量数据库,部署和运维成本相对较高
适用场景
- 企业知识库智能问答,需要处理多实体复杂关系
- 金融、医疗等领域需要可解释和精准检索的 AI 助手
- 构建多跳推理的对话系统或推荐引擎
替代项目
Microsoft GraphRAG、LlamaIndex、LangChain
同类项目推荐
khoj
开源
资料全丢给它,问啥都秒回,不用再翻文件夹
Your AI second brain. Self-hostable. Get answers from the web or your docs. Build cu···
openchatbi
开源
用聊天代替写SQL,一句话查数出图
OpenChatBI is an intelligent chat-based BI tool powered by large language models, de···
tavily-python
开源
几行代码让 Python 应用接入联网搜索与内容提取
The Tavily Python SDK allows for easy interaction with the Tavily API, offering the ···
ai-research-assistant
开源
用大白话提问,自动查资料写报告,省下几小时文献苦工。
Aria is Your AI Research Assistant Powered by GPT Large Language Models
rag-all-in-one
开源
一站式搞定 RAG 应用开发,从入门到落地少走弯路
Guide to Building RAG (Retrieval-Augmented Generation) Applications
Ataru
开源
把本地代理历史变成秒级可搜的记忆库
High-performance AI memory retrieval for local agent history — a Rust search core (···
contextgem
开源
用几行代码从文档中抽取结构化数据,告别繁琐提示词
Extract structured data and insights from documents using LLMs and decision models
album-ai
开源
跟相册聊天,用大白话找照片,AI 自动理解内容
AI-First Album: Chat with your gallery using plain language! LLM Vision + RAG + Albu···
deepsearch
开源
带逐块引用的可溯源深度搜索研究框架
openJiuwen DeepSearch is a knowledge-enhanced deep search and research framework wit···
