Introduction
R2R - The ultimate open source RAG answer engine
R2R was designed to bridge the gap between local LLM experimentation and scalable, production-ready Retrieval-Augmented Generation (RAG). R2R provides a comprehensive and SOTA RAG system for developers, built around a RESTful API for ease of use.
Key Features
- π Multimodal Support: Ingest files ranging from
.txt
,.pdf
,.json
to.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 rich observability and analytics.
- π Client-Server: RESTful API support out of the box.
- 𧩠Configurable: Provision your application using intuitive configuration files.
- π Extensible: Develop your application further with easy builder + factory pattern.
- π₯οΈ Dashboard: Use the R2R Dashboard, an open source React+Next.js app for a user-friendly interaction with R2R.
Quickstart
The R2R Quickstart provides a step-by-step guide to get up and running with R2R in minutes. The guide demonstrates R2Rβs Retrieval-Augmented Generation (RAG) system by ingesting sample documents and then showcasing features for search, RAG, logging, analytics, and document management.
Getting Started
To get started with R2R, we recommend starting with the quickstart and then moving on to specific cookbooks.
- Installation: Quick setup using
pip
. - R2R Quickstart: A quickstart guide designed to get you familiarized with R2R.
RAG Cookbooks
- Multiple LLMs: A simple cookbook showing how R2R supports multiple LLMs.
- Hybrid Search: A brief introduction to running hybrid search with R2R.
- Multimodal RAG: A cookbook on multimodal RAG with R2R.
- Knowledge Graphs: A walkthrough of automatic knowledge graph generation with R2R.
- Local RAG: A quick cookbook demonstration of how to run R2R with local LLMs.
- Reranking: A short guide on how to apply reranking to R2R results.
App Features
- Client-Server: An extension of the basic
R2R Quickstart
with client-server interactions. - Document Management: A cookbook showing how to manage your documents with R2R.
- Analytics & Observability: A cookbook showing R2Rs end to end logging and analytics.
- Dashboard: A how-to guide on connecting with the R2R Dashboard.
Sample Output
Here are some example commands along with their raw outputs:
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.
Was this page helpful?