构建、扩展和管理用于生产环境中的用户面对的检索增强生成应用程序。
概述
R2R旨在弥合本地LLM实验与可扩展的、生产就绪的检索增强生成 (RAG) 应用程序之间的差距。R2R提供了RAG的最新技术,围绕RESTful API构建,便于使用。
如需了解R2R的完整内容,请查看 完整文档。
关键特性
- 📁 多模态支持:支持从
.txt
、.pdf
、.json
到.png
、.mp3
等文件的导入。 - 🔍 混合搜索:通过递归排名融合(Reciprocal Rank Fusion)结合语义和关键字搜索,以增强相关性。
- 🔗 图形RAG:自动提取关系并构建知识图谱。
- 🗂️ 应用管理:通过全面认证,高效管理文档和用户。
- 🔭 可观测性:观察并分析您的RAG引擎性能。
- 🧩 可配置性:使用直观的配置文件来配置您的应用程序。
- 🔌 可扩展性:使用易于构建和工厂模式进一步开发您的应用程序。
- 🖥️ 仪表盘:使用 R2R Dashboard,一个开源的React+Next.js应用程序,带有可选的身份验证功能,通过GUI与R2R进行交互。
使用pip安装
建议通过我们的CLI来开始使用R2R。
pip install r2r
然后,安装R2R之后,建议通过Docker启动(如果可能):
# export OPENAI_API_KEY=sk-...
r2r serve --docker
或者,您可以直接从python包运行R2R,但需要配置额外的依赖,如Postgres+pgvector:
# export OPENAI_API_KEY=sk-...
# export POSTGRES...
r2r --config-name=default serve
快速开始
安装后,可参阅 R2R快速启动,这是一个逐步指南,可以在几分钟内让您上手R2R。该指南通过导入示例文档,然后展示搜索、RAG、日志记录、分析和文档管理功能来演示R2R的检索增强生成 (RAG) 系统。
入门步骤
要开始使用R2R,我们建议从快速启动开始,然后转向特定的食谱。
API 和 SDK
认证与管理功能
RAG 食谱
- 多LLM: 简单的食谱展示R2R如何支持多个LLM。
- 混合搜索: 简要介绍使用R2R进行混合搜索。
- 多模态RAG: 介绍多模态RAG的食谱。
- 知识图谱: 使用R2R自动生成知识图谱的演练。
- 高级图谱: 演练R2R高级RAG功能。
- 本地RAG: 如何使用本地LLM运行R2R的快速食谱演示。
- 重排序: 如何在R2R结果上应用重排序的简短指南。
社区
加入我们的Discord服务器 以获取支持并与R2R团队和社区中的其他开发者联系。无论您遇到问题、在寻找最佳实践建议,还是想分享您的经验,我们都愿意提供帮助。
贡献
我们欢迎各种规模的贡献!以下是您可以帮助的方式: