R2R
SoTA production-ready AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.
File Explorer
Download Latest Version (.zip)- action.yml
- action.yml
- action.yml
- action.yml
- action.yml
- action.yml
- action.yml
- bug_report.md
- custom.md
- feature_request.md
- build-cluster-service-docker.yml
- build-r2r-docker.yml
- build-unst-service-docker.yml
- publish-to-npm.yml
- publish-to-pypi.yml
- quality.yml
- r2r-full-py-integration-tests.yml
- r2r-js-sdk-ci.yml
- r2r-js-sdk-integration-tests.yml
- r2r-light-py-integration-tests.yml
- cm-hatchet.yaml
- cm-hatchet_OLD.yaml
- cm-init-scripts-hatchet.yaml
- cm-init-scripts-r2r.yaml
- cm-r2r.yaml
- cm-unstructured.yaml
- hatchet-dashboard-initc.yaml
- hatchet-engine-initc.yaml
- hatchet-init-job.yaml
- hatchet-rabbitmq-sts.yaml
- pgadmin.yaml
- pgvector-sts.yaml
- r2r-dashboard-indep.yaml
- r2r-graph-clustering-indep.yaml
- r2r-initc.yaml
- r2r-nginx-indep.yaml
- unstructured-indep.yaml
- hatchet-rabbitmq-sts.yaml
- rm-secret-hatchet-postgres.yaml
- rm-secret-hatchet-rabbitmq-config.yaml
- rm-secret-hatchet-rabbitmq.yaml
- rm-secret-hatchet-shared-config.yaml
- service.yaml
- helm-values_hatchet.yaml
- helm-values_postgresql.yaml
- kustomization.yaml
- externalsecret_hatchet.yaml
- externalsecret_r2r.yaml
- ingress-r2r.yaml
- secrets_hatchet.yaml
- secrets_r2r.yaml
- hatchet.env
- minio.env
- postgres.env
- r2r-dashboard.env
- r2r-full.env
- r2r.env
- fluent-bit.conf
- parsers.conf
- create-hatchet-db.sh
- setup-token.sh
- start-r2r.sh
- README.md
- README.md
- user_requirements.txt
- compose.full.swarm.yaml
- compose.full.yaml
- compose.yaml
- chat.png
- login.png
- oss_collections_page.png
- oss_dashboard_documents.png
- settings_config.png
- settings_prompts.png
- users.png
- mailersend.png
- application.md
- custom-tools.md
- email.md
- evals.md
- graphs.md
- ingestion.md
- local.md
- logging.md
- maintenance.md
- mcp.md
- orchestration.md
- structured-output.md
- web-dev.md
- {README.md}
- contextual-enrichment.md
- deduplication.md
- collections.md
- conversations.md
- documents.md
- graphs.md
- prompts.md
- users.md
- advanced-rag.md
- agentic-rag.md
- hybrid-search.md
- search-and-rag.md
- README.md
- rag.md
- what-is-r2r.md
- system.md
- README.md
- typeTransformer.test.ts
- ChunksIntegrationSuperUser.test.ts
- CollectionsIntegrationSuperUser.test.ts
- ConversationsIntegrationSuperUser.test.ts
- ConversationsIntegrationUser.test.ts
- DocumentsAndCollectionsIntegrationUser.test.ts
- DocumentsIntegrationSuperUser.test.ts
- GraphsIntegrationSuperUser.test.ts
- PromptsIntegrationSuperUser.test.ts
- RetrievalIntegrationSuperUser.test.ts
- SystemIntegrationSuperUser.test.ts
- SystemIntegrationUser.test.ts
- UsersIntegrationSuperUser.test.ts
- karamozov.txt
- myshkin.txt
- invalid.json
- marmeladov.txt
- raskolnikov.txt
- raskolnikov_2.txt
- sonia.txt
- zametov.txt
- hello_r2r.js
- index.ts
- typeTransformer.ts
- utils.ts
- chunks.ts
- collections.ts
- conversations.ts
- documents.ts
- graphs.ts
- indices.ts
- prompts.ts
- retrieval.ts
- system.ts
- users.ts
- baseClient.ts
- index.ts
- r2rClient.ts
- types.ts
- .prettierignore
- jest.config.js
- package-lock.json
- package.json
- pnpm-lock.yaml
- README.md
- tsconfig.json
- README.md
- __init__.py
- base.py
- rag.py
- research.py
- __init__.py
- get_file_content.py
- search_file_descriptions.py
- search_file_knowledge.py
- tavily_extract.py
- tavily_search.py
- web_scrape.py
- web_search.py
- registry.py
- __init__.py
- agent.py
- __init__.py
- __init__.py
- base_parser.py
- __init__.py
- auth.py
- base.py
- crypto.py
- database.py
- email.py
- embedding.py
- file.py
- ingestion.py
- llm.py
- ocr.py
- orchestration.py
- scheduler.py
- __init__.py
- __init__.py
- full.toml
- full_azure.toml
- full_lm_studio.toml
- full_ollama.toml
- gemini.toml
- lm_studio.toml
- ollama.toml
- r2r_azure.toml
- r2r_azure_with_test_limits.toml
- r2r_with_auth.toml
- tavily.toml
- aristotle.txt
- aristotle_v2.txt
- aristotle_v3.txt
- DeepSeek_R1.pdf
- got.txt
- graphrag.pdf
- lyft_2021.pdf
- pg_essay_1.html
- pg_essay_2.html
- pg_essay_3.html
- pg_essay_4.html
- pg_essay_5.html
- sample.mp3
- sample2.mp3
- screen_shot.png
- test.txt
- uber_2021.pdf
- yc_companies.txt
- bmp.bmp
- css.css
- csv.csv
- doc.doc
- docx.docx
- eml.eml
- epub.epub
- heic.heic
- html.html
- jpeg.jpeg
- jpg.jpg
- js.js
- json.json
- md.md
- msg.msg
- odt.odt
- org.org
- p7s.p7s
- pdf.pdf
- png.png
- ppt.ppt
- pptx.pptx
- py.py
- rst.rst
- rtf.rtf
- tiff.tiff
- ts.ts
- tsv.tsv
- txt.txt
- xls.xls
- xlsx.xlsx
- __init__.py
- hello_r2r.ipynb
- hello_r2r.py
- base_router.py
- chunks_router.py
- collections_router.py
- conversations_router.py
- documents_router.py
- graph_router.py
- indices_router.py
- prompts_router.py
- retrieval_router.py
- system_router.py
- users_router.py
- __init__.py
- builder.py
- factory.py
- utils.py
- __init__.py
- project_schema.py
- __init__.py
- graph_workflow.py
- ingestion_workflow.py
- __init__.py
- graph_workflow.py
- ingestion_workflow.py
- __init__.py
- __init__.py
- auth_service.py
- base.py
- graph_service.py
- ingestion_service.py
- maintenance_service.py
- management_service.py
- retrieval_service.py
- __init__.py
- abstractions.py
- app.py
- app_entry.py
- config.py
- __init__.py
- audio_parser.py
- bmp_parser.py
- doc_parser.py
- docx_parser.py
- img_parser.py
- odt_parser.py
- pdf_parser.py
- ppt_parser.py
- pptx_parser.py
- rtf_parser.py
- __init__.py
- csv_parser.py
- eml_parser.py
- epub_parser.py
- json_parser.py
- msg_parser.py
- org_parser.py
- p7s_parser.py
- rst_parser.py
- tsv_parser.py
- xls_parser.py
- xlsx_parser.py
- __init__.py
- css_parser.py
- html_parser.py
- js_parser.py
- md_parser.py
- python_parser.py
- text_parser.py
- ts_parser.py
- __init__.py
- __init__.py
- clerk.py
- jwt.py
- r2r_auth.py
- supabase.py
- __init__.py
- bcrypt.py
- nacl.py
- __init__.py
- chunk_enrichment.yaml
- collection_summary.yaml
- dynamic_rag_agent.yaml
- dynamic_rag_agent_xml_tooling.yaml
- graph_communities.yaml
- graph_entity_description.yaml
- graph_extraction.yaml
- hyde.yaml
- rag.yaml
- rag_fusion.yaml
- static_rag_agent.yaml
- static_research_agent.yaml
- summary.yaml
- system.yaml
- vision_img.yaml
- vision_pdf.yaml
- __init__.py
- base.py
- chunks.py
- collections.py
- conversations.py
- documents.py
- filters.py
- graphs.py
- limits.py
- maintenance.py
- postgres.py
- prompts_handler.py
- tokens.py
- users.py
- utils.py
- __init__.py
- console_mock.py
- mailersend.py
- sendgrid.py
- smtp.py
- __init__.py
- litellm.py
- ollama.py
- openai.py
- utils.py
- __init__.py
- postgres.py
- s3.py
- base.py
- base.py
- __init__.py
- __init__.py
- anthropic.py
- azure_foundry.py
- litellm.py
- openai.py
- r2r_llm.py
- utils.py
- __init__.py
- mistral.py
- __init__.py
- hatchet.py
- simple.py
- __init__.py
- apscheduler.py
- __init__.py
- __init__.py
- context.py
- logging_config.py
- sentry.py
- serper.py
- __init__.py
- 2fac23e4d91b_migrate_to_document_search.py
- 3efc7b3b1b3d_add_total_tokens_count.py
- 7eb70560f406_add_limits_overrides_to_users.py
- 8077140e1e99_v3_api_database_revision.py
- c45a9cf6a8a4_add_user_and_document_count_to_.py
- d342e632358a_migrate_to_asyncpg.py
- alembic.ini
- env.py
- README
- script.py.mako
- __init__.py
- mcp.py
- r2r.toml
- serve.py
- __init__.py
- chunks.py
- collections.py
- conversations.py
- documents.py
- graphs.py
- indices.py
- prompts.py
- retrieval.py
- system.py
- users.py
- __init_.py
- base_client.py
- __init__.py
- chunks.py
- collections.py
- conversations.py
- documents.py
- graphs.py
- indices.py
- prompts.py
- retrieval.py
- system.py
- users.py
- __init__.py
- async_client.py
- models.py
- README.md
- sync_client.py
- __init__.py
- base.py
- document.py
- exception.py
- graph.py
- llm.py
- prompt.py
- search.py
- tool.py
- user.py
- vector.py
- __init__.py
- responses.py
- __init__.py
- responses.py
- __init__.py
- responses.py
- __init__.py
- responses.py
- __init__.py
- responses.py
- __init__.py
- base.py
- __init__.py
- text.py
- __init__.py
- base_utils.py
- __init__.py
- conftest.py
- test_agent.py
- test_base.py
- test_chunks.py
- test_collections.py
- test_collections_users_interaction.py
- test_conversations.py
- test_documents.py
- test_filters.py
- test_graphs.py
- test_indices.py
- test_ingestion.py
- test_retrieval.py
- test_retrieval_advanced.py
- test_system.py
- test_users.py
- __init__.py
- loadTester.py
- test_agent.py
- test_agent_citations.py
- test_agent_citations_old.py
- test_agent_old.py
- test_streaming_agent.py
- test_config.py
- test_routes.py
- test_collections.py
- test_conversations.py
- test_graphs.py
- test_limits.py
- test_chunks.py
- test_document_processing.py
- test_documents.py
- __init__.py
- conftest.py
- test_citations.py
- test_database_filters.py
- test_rag_processing.py
- test_retrieval_old.py
- conftest.py
- .dockerignore
- all_possible_config.toml
- Dockerfile
- pyproject.toml
- README.md
- uv.lock
- Dockerfile.clustering
- main.py
- Dockerfile.unstructured
- main.py
- README.md
- README.md
- .env.example
- .gitattributes
- .gitignore
- .pre-commit-config.yaml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- LICENSE.md
- llms.txt
- MANIFEST.md
- README.md
- SECURITY.md
# Installation Guide
1. Get the code
git clone https://github.com/SciPhi-AI/R2R
Downloads the entire project code from GitHub to your computer.
cd R2R
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker/compose.full.swarm.yaml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd js/sdk
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
4. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly β no need to clone the source.
jupyter notebook
Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)