rags

用大白话跟数据聊天,自动出结果

开源 🏷️完全免费 🔧 仅开源项目,无在线服务,需自行部署 对话助手 🍴 复刻 653 🐛 待处理 39 👀 关注 54 ⚠️ 作者已归档(停止维护)
GitHub ↗
GitHub 星标 ★ 6547
维护状态 低维护
是否开源 开源
定价模式 🏷️完全免费 开源项目,MIT许可证,可免费使用和部署。

项目预览

rags 项目界面预览图
图片来源:GitHub 官方仓库名片

项目数据

分类对话助手
开发团队run-llama
定价模式🏷️完全免费
价格说明开源项目,MIT许可证,可免费使用和部署。
访问状态🔧 仅开源项目,无在线服务,需自行部署
是否开源是
开源协议MIT
主要语言Python
技术栈/模型agent,chatbot,chatgpt,gpts,llamaindex,llm,openai,rag,streamlit
GitHub 星标★ 6547
上线时间2023-11-16 00:00:00
代码更新2024-04-05
仓库体积160 KB
本站数据更新2026-11-09
维护状态低维护
收录时间2026-08-09
浏览次数3

项目介绍

rags 是一个基于自然语言的数据对话助手框架,旨在让用户通过聊天的方式直接与自己的数据交互,无需编写代码。它利用 RAG(检索增强生成)技术,将用户的数据源(如文档、数据库等)与大型语言模型(LLM)结合,支持多轮对话、上下文记忆和智能检索。项目基于 Python 构建,集成了 LlamaIndex、OpenAI 和 Streamlit,提供了可视化的聊天界面,降低了使用门槛。核心能力包括:自然语言查询、数据源灵活接入、对话式分析、以及可扩展的 Agent 机制。它解决的是传统数据分析中需要编写复杂查询或依赖专业人员的问题,让非技术用户也能通过对话获取洞察。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 6547

使用教程

难度:入门 约 10 分钟 部署方式:本地安装 5 步

环境要求

  • Python 3 环境(README 使用 python3 创建虚拟环境)
  • 已安装 Poetry 包管理工具(需执行 poetry install)
  • 一个可用的 OpenAI API Key(默认使用 OpenAI 作为构建与 RAG 智能体)
  • 能访问 GitHub 克隆仓库的网络环境

安装与启动步骤

  1. 1克隆项目仓库

    把 rags 仓库克隆到本地,克隆完成后进入项目文件夹,后续命令都在该目录内执行。

    git clone https://github.com/run-llama/rags.git
    cd rags
  2. 2创建虚拟环境

    README 推荐为依赖创建独立虚拟环境,避免污染系统 Python 环境;创建后需自行激活(如 source .venv/bin/activate)。

    python3 -m venv .venv
  3. 3安装项目依赖

    使用 Poetry 安装依赖,README 指定带 dev 依赖组安装,需等待依赖下载完成。

    poetry install --with dev
  4. 4配置 OpenAI 密钥

    在项目根目录下的 .streamlit/secrets.toml 中写入 openai_key,README 要求该文件放在 home 文件夹下。

    mkdir -p .streamlit
    printf 'openai_key = "sk-xxxxxxxx"\n' > .streamlit/secrets.toml
  5. 5启动 Streamlit 应用

    从 home page 文件启动应用,启动后终端会输出本地访问地址,在浏览器中打开即可使用。

    streamlit run 1__Home.py

关键配置

配置项必填说明示例
openai_key是OpenAI API 密钥,构建智能体和生成的 RAG 智能体默认都使用它sk-xxxxxxxx

如何确认成功

终端出现 Streamlit 的 Local URL(通常是 http://localhost:8501),浏览器打开后能看到 Home 页面即启动成功。

常见问题

Q:没有安装 Poetry 怎么办?

A:README 的安装说明依赖 poetry install,需先自行安装 Poetry(如 pip install poetry)后再回到项目目录执行该命令。

Q:升级 RAGs 版本后启动报错怎么处理?

A:README 提示版本间存储数据结构可能有破坏性变更,可删除 home 目录下的 cache 文件夹后重新启动。

Q:secrets.toml 应该放在哪里?

A:README 要求在 home 文件夹下添加 .streamlit/secrets.toml,并写入 openai_key = "<openai_key>"。

Q:必须使用 OpenAI 吗?

A:README 说明默认构建智能体和生成的 RAG 智能体都使用 OpenAI,因此需要提供有效的 OpenAI 密钥。

注意事项

  • README 推荐先创建并激活虚拟环境再安装依赖
  • 密钥文件路径为 .streamlit/secrets.toml,需放在项目/home 文件夹下
  • 启动入口是 home page 文件 1__Home.py,文件名含表情符号,建议加引号执行
  • 跨版本升级后如启动异常,先删除 home 目录下的 cache 文件夹

核心亮点

  • 自然语言直接查询数据,无需写SQL或代码
  • 集成LlamaIndex和OpenAI,RAG检索准确度高
  • Streamlit界面,部署简单,几分钟上手

不足之处

  • 依赖外部API,离线或私有化部署受限
  • 文档/社区待观察

适用场景

  • 业务人员快速查询销售报表
  • 企业内部知识库问答
  • 数据科学家快速原型验证

替代项目

LangChain、Haystack、Dify

上一篇:BYO-LLM-WIKI

下一篇:bRAG-langchain

同类项目推荐

sweet-search 开源

给 AI 代理的本地代码搜索,比 grep 更省更准

Local code search for AI agents: cheaper, faster and sweeter. Because maybe grep isn···

★ 115 2026-11-08
kaas 开源

把散乱笔记编译成可查询的 Markdown 知识库,供 AI 代理调用。

Turn scattered notes, docs and transcripts into a queryable Markdown wiki — an LLM ···

★ 153 2026-08-09
graphify 开源

整个代码库画成一张图,找问题一眼定位

Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable k···

★ 144512 2026-08-09
leettools-archive 开源

把大模型接进搜索流程,快速搭出带引用的智能问答原型

AI Search tools.

★ 340 2026-10-24
graphiti 开源

让AI智能体实时构建可追溯的知识图谱,告别静态RAG

Build Real-Time Knowledge Graphs for AI Agents

★ 32664 2026-08-09
UltimateRAG 开源

按路线图从零到企业级,跑通并进阶 RAG 文档问答

一个按路线图逐步实现的 RAG 学习项目:从 Naive RAG → Advanced RAG → Agentic RAG → ···

★ 232 2026-09-12
nano-graphrag 开源

轻量可改的 GraphRAG,让你快速跑通并魔改知识图谱问答

A simple, easy-to-hack GraphRAG implementation

★ 4001 2026-08-09
patent-literature-search-mcp 开源

一个接口搜遍全球专利和学术文献,让AI帮你做创新情报分析

Search global patents across WIPO, EPO, USPTO, CNIPA, JPO, KIPO and other authoritie···

★ 85 2026-08-09