Screenshot 2025-03-27 at 6 35 02 AM

The most advanced AI retrieval system.

Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.

About

R2R is an advanced AI retrieval system supporting Retrieval-Augmented Generation (RAG) with production-ready features. Built around a RESTful API, R2R offers multimodal content ingestion, hybrid search, knowledge graphs, and comprehensive document management.

R2R also includes a Deep Research API, a multi-step reasoning system that fetches relevant data from your knowledgebase and/or the internet to deliver richer, context-aware answers for complex queries.

Usage

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

# RAG with citations
response = client.retrieval.rag(query="What is DeepSeek R1?")

# Deep Research RAG 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,
  },
)

Getting Started

# Quick install and run in light mode
pip install r2r
export OPENAI_API_KEY=sk-...
python -m r2r.serve

# Or run in full mode with 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

For detailed self-hosting instructions, see the self-hosting docs.

Demo

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

Using the API

1. Install SDK & Setup

# Install SDK
pip install r2r  # Python
# or
npm i r2r-js    # JavaScript

2. Client Initialization

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

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

3. Document Operations

# Ingest sample or your own document
client.documents.create(file_path="/path/to/file")

# List documents
client.documents.list()

Key Features

  • 📁 Multimodal Ingestion: Parse .txt, .pdf, .json, .png, .mp3, and more
  • 🔍 Hybrid Search: Semantic + keyword search with reciprocal rank fusion
  • 🔗 Knowledge Graphs: Automatic entity & relationship extraction
  • 🤖 Agentic RAG: Reasoning agent integrated with retrieval
  • 🔐 User & Access Management: Complete authentication & collection system

Community & Contributing

Our Contributors

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for emrgnt-cmplxty from gravatar.com emrgnt-cmplxty

Credits

Author: Owen Colegrove

License

MIT

Requires

Python <3.13, >=3.10

Provides Extra

core

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

r2r-3.6.6.tar.gz (396.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

r2r-3.6.6-py3-none-any.whl (514.0 kB view details)

Uploaded Python 3

File details

Details for the file r2r-3.6.6.tar.gz.

File metadata

  • Download URL: r2r-3.6.6.tar.gz
  • Upload date:
  • Size: 396.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for r2r-3.6.6.tar.gz
Algorithm Hash digest
SHA256 f84c626e7fd9512ea312c75cc1d20221223a391222c382980a82100f25697258
MD5 8cb2f3505bc4f144a52c487cf3de0456
BLAKE2b-256 81009b9953e9adf115ed245e4d52ce1a9d8cbc4ae2c037315b748a7f0e2f1f6e

See more details on using hashes here.

File details

Details for the file r2r-3.6.6-py3-none-any.whl.

File metadata

  • Download URL: r2r-3.6.6-py3-none-any.whl
  • Upload date:
  • Size: 514.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for r2r-3.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 48c9326db0ff23c41affdb846df0c9014827b1316a14bcc87bb43c810b0410f9
MD5 a6d3f905c1e4f9e537dac7d9d1f4b92a
BLAKE2b-256 1413ad97d16a161bd96148b7562c3f6298c9cae79c7e0b7b1025a2fc74da95c0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.6.6

3.6.5

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.19

3.5.18

3.5.17

3.5.16

3.5.15

3.5.14

3.5.13

3.5.12

3.5.11

3.5.10

3.5.9

3.5.8

3.5.7

3.5.6

3.5.5

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.41

3.3.40

3.3.32

3.3.31

3.3.29

3.3.28

3.3.27

3.3.24

3.3.23

3.3.22

3.3.21

3.3.19

3.3.18

3.3.17

3.3.16

3.3.15

3.3.13

3.3.11

3.3.10

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.41

3.2.40

3.2.39

3.2.38

3.2.37

3.2.36

3.2.35

3.2.34

3.2.33

3.2.32

3.2.31

3.2.30

3.2.17

3.2.16

3.2.15

3.2.14

3.2.13

3.2.12

3.2.11

3.2.10

3.2.9

3.2.8

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.53

3.1.52

3.1.51

3.1.50

3.1.48

3.1.47

3.1.46

3.1.45

3.1.44

3.1.43

3.1.42

3.1.41

3.1.40

3.1.38

3.1.37

3.1.36

3.1.35

3.1.34

3.1.33

3.1.32

3.1.31

3.1.30

3.1.29

3.1.28

3.1.27

3.1.26

3.1.25

3.1.24

3.1.23

3.1.22

3.1.21

3.1.20

3.1.19

3.1.17

3.1.16

3.1.14

3.1.13

3.1.12

3.1.2

3.1.1

3.1.0

3.0.8

3.0.7

3.0.6

3.0.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.85

0.2.84

0.2.83

0.2.82

0.2.81

0.2.80

0.2.79

0.2.78

0.2.77

0.2.76

0.2.75

0.2.74

0.2.73

0.2.72

0.2.71

0.2.70

0.2.69

0.2.68

0.2.67

0.2.66

0.2.65

0.2.64

0.2.62

0.2.61

0.2.60

0.2.59

0.2.58

0.2.57

0.2.56

0.2.55

0.2.54

0.2.53

0.2.52

0.2.51

0.2.50

0.2.49

0.2.47

0.2.46

0.2.45

0.2.43

0.2.42

0.2.41

0.2.40

0.2.39

0.2.38

0.2.37

0.2.36

0.2.35

0.2.33

0.2.32

0.2.31

0.2.22

0.2.21

0.2.20

0.2.19

0.2.18

0.2.17

0.2.16

0.2.15

0.2.12

0.2.11

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.35

0.1.34

0.1.33

0.1.32

0.1.31

0.1.29

0.1.28

0.1.27

0.1.26

0.1.25

0.1.24

0.1.23

0.1.22

0.1.21

0.1.2

0.1.1

0.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page