
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 8075
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Python 环境(可通过 pip 安装 r2r)
- OpenAI API Key,配置到环境变量 OPENAI_API_KEY
- 使用全模式需安装 Docker 与 Docker Compose
- 全模式需要本地存在 compose.full.yaml 文件
安装与启动步骤
-
1安装 R2R
通过 pip 安装 R2R 包,这是 README 给出的 quick install 方式。
pip install r2r -
2配置 API 密钥
设置 OPENAI_API_KEY 环境变量;示例中的 sk-... 需换成你自己的真实密钥。
export OPENAI_API_KEY=sk-... -
3启动轻量服务
以 light 模式启动 R2R 服务,执行后保持终端运行以查看日志。
python -m r2r.serve -
4全模式 Docker 启动
用 compose.full.yaml 的 postgres profile 启动完整模式,需在该文件所在目录执行。
docker compose -f compose.full.yaml --profile postgres up -d
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | OpenAI 接口密钥,供模型调用使用 | sk-xxxxxxxxxxxxxxxx |
如何确认成功
执行 python -m r2r.serve 后终端持续输出服务日志且无报错;Docker 模式下容器保持运行即为成功。
常见问题
Q:不用 OpenAI 可以吗?
A:README 只示范了 OPENAI_API_KEY,其他模型与嵌入方案未给出,需查阅官方 self-hosting 文档。
Q:light 模式和 full 模式有什么区别?
A:README 仅说明 light 模式用 pip 直接运行、full 模式用 Docker 加 postgres profile,细节见官方自托管文档。
Q:服务监听哪个端口?
A:README 未给出默认端口或访问地址,请参考官方 self-hosting 文档确认。
Q:TypeScript SDK 怎么安装?
A:README 只给出 Python SDK 的 pip install r2r,未提供 TS 安装命令。
注意事项
- README 未写明默认端口、数据目录等参数,细节请查阅官方 self-hosting 文档。
- API Key 属敏感信息,不要写入代码或提交到 Git 仓库。
- 全模式依赖 Docker 与 compose.full.yaml,请确认文件存在再执行命令。
核心亮点
- 提供完整的 RESTful API,后端集成简单,前端可快速调用
- 内置多模态数据解析(文本/图像/音频),扩展了检索范围
- 支持知识图谱与混合搜索,检索精度高于纯向量方案
不足之处
- 项目较新,文档和社区生态仍在完善中
- 高级功能(如多智能体协作)配置复杂度较高,学习曲线陡峭
适用场景
- 企业知识库智能问答系统
- 多模态内容检索(如文档、图片、音频混合搜索)
- 需要快速搭建生产级 RAG 服务的开发团队
替代项目
LangChain、LlamaIndex、Haystack
上一篇:deep-searcher
下一篇:vespa
同类项目推荐
kensaku
开源
本地搜文档、代码和截图,还能给 AI 代理调用
Search inside documents, code, and even screenshots - instantly and locally. A free,···
langconnect
开源
上传文档即得问答 API,省去自建 RAG 管道
A managed RAG API server.
LLM-Document-Chat
开源
用 LlamaIndex 和 Redis 让 PDF 开口说话,直接提问文档内容。
Using LlamaIndex, Redis, and OpenAI to chat with PDF documents. Supplementary materi···
vespa
开源
用 AI 搜索平台,构建实时推荐与语义检索应用
The AI search platform
statespace
开源
让AI代理快速搜到想要的网页结果
A/B test code changes on your own infrastructure
swirl-search
开源
数据不用搬家,100多个应用里的资料随问随到
AI Search & RAG Without Moving Your Data. Get instant answers from your company's kn···
coding_agent_session_search
开源
一个终端工具,搜遍所有 AI 编码助手的聊天记录。
Unified TUI and CLI to index and search your local coding agent session history acro···
memex
开源
一句话搜回所有 AI 编程会话,还能续聊和算 token
Search Claude Code, Codex, Pi, OpenCode, Github Copilot & Cursor transcripts. Resume···
feeds.fun
开源
用标签和 AI 评分,让新闻阅读更聪明
News reader with tags, scoring, and LLM