run-llama/rags

项目概览

rags 提供了一种基于自然语言指令构建并配置 RAG 流水线的方式，用户还可对生成的参数进行手动查看与微调。

项目类型

AI Agent · RAG 与知识库 · AI 工作流

应用场景

知识问答

部署方式

查看项目说明

License

MIT

适合谁

• 希望通过对话式交互构建 RAG 原型，而不想在初始阶段处理复杂参数配置的开发者。
• 需要在一个统一工具内完成从数据接入、流水线生成到问答测试流程的团队。

核心能力

• 做什么：根据自然语言描述搭建 RAG。如何工作：用户向构建器智能体描述数据集、任务和参数，构建器据此生成流水线配置。用户价值：减少手动编写配置代码和调参的步骤。状态：可用。
• 做什么：审查和修改自动生成的参数。如何工作：提供界面展示生成的 top-k、chunk size、嵌入模型、LLM 和系统提示词等参数，并允许手动覆盖修改。用户价值：为有特定需求的用户提供精细调优的灵活性。状态：可用。
• 做什么：基于生成好的 RAG 智能体与数据进行问答。如何工作：聊天界面接收用户的自然语言查询，调用底层的 RAG 智能体检索数据并生成答案。用户价值：提供现成的交互前端，用于验证 RAG 系统的问答效果。状态：可用。
• 做什么：更换负责搭建流水线的构建器背后的 LLM。如何工作：允许将构建器智能体配置为使用不同的 LLM（默认为 OpenAI，支持 Anthropic），但需注意目前 Claude 模型无法可靠地完成构建工作。用户价值：用户可根据偏好选择模型来理解指令并生成配置。状态：可用。
• 做什么：为最终生成用于问答的 RAG 智能体配置模型。如何工作：支持通过自然语言或手动方式，将 OpenAI、Anthropic、Replicate 或 HuggingFace 的 LLM，以及 OpenAI 或 HuggingFace 的嵌入模型接入生成的智能体。用户价值：使数据问答系统能够适配不同的模型生态。状态：可用。

限制与风险

• 目前使用 Claude 系列模型构建智能体时无法保证可靠运行，推荐使用 GPT-4 系列模型以获得更可靠的结果。
• 升级版本可能引入破坏性变更，导致已存储的数据结构与新版不兼容，此时需要手动删除本地缓存才能正常运行。

如何开始

• 预估上手难度为中等，需完成约 4 个主要步骤：1. 克隆项目；2. 创建虚拟环境并运行 poetry install --with dev 安装依赖；3. 手动创建 .streamlit/secrets.toml 文件并填入 OpenAI API 密钥；4. 执行 streamlit run 1_🏠_Home.py 启动应用。

核验依据

• README: RAGs is a Streamlit app that lets you create a RAG pipeline from a data source using natural language.
• README: Describe your task (e.g. "load this web page") and the parameters you want from your RAG systems (e.g. "i want to retrieve X number of docs")
• README: By default, we use OpenAI for both the builder agent as well as the generated RAG agent. Add `.streamlit/secrets.toml` in the home folder. Then put the following: openai_key = "<o…
• README: Currently we support either **a single local file** or a **web page**.
• README: In this section, you have a UI showcasing the generated parameters and have full freedom to manually edit/change them as necessary.

内容核验时间：