Skip to content
/ R2R Public

The most advanced AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.

License

Notifications You must be signed in to change notification settings

SciPhi-AI/R2R

Repository files navigation

Screenshot 2025-01-30 at 5 11 34 PM

The most advanced AI retrieval system.

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

About

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

For a more complete view of R2R, check out the full documentation.

Getting Started

Access R2R through a deployment managed by the SciPhi team, which includes a generous free-tier. No credit card required.

Local

Install and run R2R:

# Install the R2R package
pip install r2r

# Set necessary environment variables
export OPENAI_API_KEY=sk-...

# Run R2R in `light` mode
python -m r2r.serve

# Alternatively, run R2R in `full` mode
# git clone [email protected]:SciPhi-AI/R2R.git . && cd R2R
# COMPOSE_PROFILES=postgres docker compose -f compose.full.yaml down

# Refer to docs for local LLM setup - https://r2r-docs.sciphi.ai/self-hosting/local-rag

Key Features

Ingestion & Retrieval

  • 📁 Multimodal Ingestion Parse .txt, .pdf, .json, .png, .mp3, and more.
  • 🔍 Hybrid Search Combine semantic and keyword search with reciprocal rank fusion for enhanced relevancy.
  • 🔗 Knowledge Graphs Automatically extract entities and relationships to build knowledge graphs.
  • 🤖 Agentic RAG R2R's powerful reasoning agent integrated with RAG.

Application Layer

Self-Hosting

  • 🐋 Docker Use Docker to easily deploy the full R2R system into your local environment
  • 🧩 Configuration Set up your application using intuitive configuration files.

Community

Join our Discord to get support and connect with both the R2R team and other developers in the community. Whether you're encountering issues, looking for advice on best practices, or just want to share your experiences, we're here to help.

Contributing

We welcome contributions of all sizes! Here's how you can help:

Our Contributors