r2r 3.1.23

SciPhi R2R

The Elasticsearch for RAG.

Build, scale, and deploy production-ready Retrieval-Augmented Generation applications.

About

R2R (RAG to Riches), the Elasticsearch for RAG, bridges the gap between experimenting with and deploying production-ready Retrieval-Augmented Generation (RAG) applications. It's a complete platform that helps you quickly build and launch scalable RAG solutions. Built around a containerized RESTful API, R2R offers multimodal ingestion support, hybrid search, GraphRAG capabilities, user management, and observability features.

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

Key Features

• 📁 Multimodal Ingestion: Parse .txt, .pdf, .json, .png, .mp3, and more.
• 🔍 Hybrid Search: Combine semantic and keyword search with reciprocal rank fusion for enhanced relevancy.
• 🔗 Graph RAG: Automatically extract relationships and build knowledge graphs.
• 🗂️ App Management: Efficiently manage documents and users with full authentication.
• 🔭 Observability: Observe and analyze your RAG engine performance.
• 🧩 Configurable: Provision your application using intuitive configuration files.
• 🖥️ Dashboard: An open-source React+Next.js app with optional authentication, to interact with R2R via GUI.

What's New

• Release 3.1.0    September 6, 2024    

  Warning: These changes are breaking! We will be releasing a migration script soon.

  • Orchestration with Hatchet
  • Default ingestion provider set to Unstructured
  • Improved knowledge graph construction process

Install with pip

The recommended way to get started with R2R is by using our CLI.

pip install r2r

Then, after installing R2R, it is recommended to launch with Docker, if possible:

# export OPENAI_API_KEY=sk-...
r2r serve --docker

Alternatively, you may run R2R directly from the python package, but additional dependencies like Postgres+pgvector must be configured and the full R2R core is required:

# export OPENAI_API_KEY=sk-...
# export POSTGRES...
pip install 'r2r[core]'
r2r --config-name=default serve

Getting Started

• Installation: Quick installation of R2R using Docker or pip
• Quickstart: A quick introduction to R2R's core features

API & SDKs

• SDK: API reference and Python/JS SDKs for interacting with R2R
• API: API reference and Python/JS SDKs for interacting with R2R
• Configuration: A guide on how to configure your R2R system

Cookbooks

• Advanced RAG Pipelines

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

• Knowledge Graphs

  • GraphRAG: Walkthrough of GraphRAG

• Auth & Admin Features

  • Web Development: Building webapps using R2R
  • User Auth: Authenticating users
  • Group Permissions: Group permissions
  • Analytics & Observability: End-to-end logging and analytics
  • Web Application: Connecting with the R2R Application

Community

Join our Discord server 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