r2r

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

Sign up · Self Host

Docs · Report Bug · Feature Request · Discord

About

R2R (RAG to Riches) 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.

Key Features

• 📁 Multimodal Ingestion: Support for over 26 files types, including .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, build knowledge graphs, and run GraphRAG.
• 🗂️ User Management: Efficiently manage documents and user roles within R2R.
• 🔭 Observability: Observe and analyze your RAG engine performance.
• 🧩 Configuration: Setup your application using intuitive configuration files.
• 🖥️ Dashboard: An open-source React+Next.js admin dashboard to interact with R2R via GUI.

Getting Started

SciPhi Cloud

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

Self Hosting

Install R2R:

# Install the R2R package
pip install r2r

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

# Run the server and database
r2r serve --docker --full

The command above will install the full installation which includes Hatchet for orchestration and Unstructured.io for parsing.

Resources and Cookbooks

• Quickstart: A quick introduction to R2R's core features

• Self Hosting Installation: Self hosted installation of R2R

• API & SDKs: API reference and Python/JS SDKs for interacting with R2R

• Advanced Retrieval

  • RAG Agent: R2R's powerful RAG agent
  • Hybrid Search: Introduction to hybrid search
  • Advanced RAG: Advanced RAG features

Cookbooks

• Ingestion: Learn how to ingest, update, and delete documents with R2R
• Knowledge Graphs: Building and managing graphs through collections
• Orchestration: Learn how orchestration is handled inside R2R
• Maintenance & Scaling: Learn how to maintain and scale your R2R system
• Web Development: Learn how to build webapps powered by RAG using R2R

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:

• Open a PR for new features, improvements, or better documentation.
• Submit a feature request or bug report

Our Contributors