最先进的AI检索系统。

具有RESTful API的代理式增强生成（RAG）。

关于

R2R是一个先进的AI检索系统，支持生产级特性的增强生成（RAG）。它基于RESTful API构建，提供多模态内容摄取、混合搜索、知识图谱以及全面的文档管理功能。

R2R还包含一个深度研究API，这是一个多步推理系统，可以从您的知识库和/或互联网中获取相关数据，从而为复杂查询提供更丰富、更具上下文感知的答案。

使用方法

# 基本搜索
results = client.retrieval.search(query="什么是DeepSeek R1？")

# 带引用的RAG
response = client.retrieval.rag(query="什么是DeepSeek R1？")

# 深度研究RAG代理
response = client.retrieval.agent(
  message={"role":"user", "content": "Deepseek R1意味着什么？请考虑市场、社会影响等方面。"},
  rag_generation_config={
    "model": "anthropic/claude-3-7-sonnet-20250219",
    "extended_thinking": True,
    "thinking_budget": 4096,
    "temperature": 1,
    "top_p": None,
    "max_tokens_to_sample": 16000,
  },
)

快速开始

# 轻量模式下的快速安装与运行
pip install r2r
export OPENAI_API_KEY=sk-...
python -m r2r.serve

# 或者使用Docker以完整模式运行
# git clone git@github.com:SciPhi-AI/R2R.git && cd R2R
# export R2R_CONFIG_NAME=full OPENAI_API_KEY=sk-...
# docker compose -f compose.full.yaml --profile postgres up -d

有关详细的自托管说明，请参阅自托管文档。

演示

https://github.com/user-attachments/assets/173f7a1f-7c0b-4055-b667-e2cdcf70128b

使用API

1. 安装SDK并设置

# 安装SDK
pip install r2r  # Python
# 或
npm i r2r-js    # JavaScript

2. 初始化客户端

from r2r import R2RClient
client = R2RClient(base_url="http://localhost:7272")

const { r2rClient } = require('r2r-js');
const client = new r2rClient("http://localhost:7272");

3. 文档操作

# 摄取示例文档或您自己的文档
client.documents.create(file_path="/path/to/file")

# 列出文档
client.documents.list()

核心功能

• 📁 多模态摄取: 支持解析.txt、.pdf、.json、.png、.mp3等格式
• 🔍 混合搜索: 语义搜索结合关键词搜索，并采用互反排序融合技术
• 🔗 知识图谱: 自动提取实体与关系
• 🤖 代理式RAG: 集成检索的推理代理
• 🔐 用户与访问管理: 完整的身份验证与集合管理系统

社区与贡献

• 加入我们的Discord 以获取支持和讨论
• 提交功能请求或错误报告
• 欢迎为新功能、改进或文档提交PR

我们的贡献者

R2R 快速上手指南

R2R 是一个先进的 AI 检索系统，支持基于 RESTful API 的代理式检索增强生成（Agentic RAG）。它具备多模态内容摄入、混合搜索、知识图谱构建以及深度研究（Deep Research）等功能。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (WSL2 推荐)
• Python 版本：Python 3.9 或更高版本
• API 密钥：需要配置大模型 API 密钥（如 OPENAI_API_KEY），用于驱动嵌入和生成功能。
• 可选依赖：若需使用完整功能（如持久化存储），建议安装 Docker 和 Docker Compose。

安装步骤

您可以选择轻量级模式（快速体验）或完整模式（生产级部署）。

方式一：轻量级模式（推荐快速尝试）

通过 pip 直接安装并启动服务：

# 安装 R2R Python SDK
pip install r2r

# 设置 API 密钥 (替换为您的实际密钥)
export OPENAI_API_KEY=sk-...

# 启动 R2R 服务
python -m r2r.serve

方式二：完整模式（使用 Docker）

适用于需要持久化数据库和完整功能的场景：

# 克隆仓库
git clone git@github.com:SciPhi-AI/R2R.git && cd R2R

# 设置环境变量
export R2R_CONFIG_NAME=full
export OPENAI_API_KEY=sk-...

# 使用 Docker Compose 启动 (包含 PostgreSQL)
docker compose -f compose.full.yaml --profile postgres up -d

提示：国内用户若遇到 pip 下载缓慢，可使用清华源加速安装： pip install r2r -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

服务启动后（默认地址 http://localhost:7272），您可以通过 Python 或 JavaScript SDK 进行交互。

1. 初始化客户端

Python:

from r2r import R2RClient
client = R2RClient(base_url="http://localhost:7272")

JavaScript:

const { r2rClient } = require('r2r-js');
const client = new r2rClient("http://localhost:7272");

2. 文档摄入与管理

上传本地文件到知识库：

# 摄入文档 (支持 .txt, .pdf, .json, .png, .mp3 等多模态格式)
client.documents.create(file_path="/path/to/file")

# 查看已摄入的文档列表
client.documents.list()

3. 执行检索与 RAG

基础搜索：

results = client.retrieval.search(query="What is DeepSeek R1?")

带引用的 RAG 生成：

response = client.retrieval.rag(query="What is DeepSeek R1?")

深度研究代理（Deep Research Agent）： 针对复杂问题进行多步推理和深度分析：

response = client.retrieval.agent(
  message={"role":"user", "content": "What does deepseek r1 imply? Think about market, societal implications, and more."},
  rag_generation_config={
    "model": "anthropic/claude-3-7-sonnet-20250219",
    "extended_thinking": True,
    "thinking_budget": 4096,
    "temperature": 1,
    "top_p": None,
    "max_tokens_to_sample": 16000,
  },
)