rags

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

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

开源 free 对话助手
访问官网 ↗ GitHub ↗ 文档 ↗
GitHub 星标 ★ 6551
维护状态 低维护
是否开源
定价模式 free

项目数据

分类对话助手
开发团队run-llama
所属国家
官网地址
定价模式free
价格说明开源项目,MIT许可证,可免费使用和部署。
访问状态
是否开源
开源协议MIT
主要语言Python
技术栈/模型agent,chatbot,chatgpt,gpts,llamaindex,llm,openai,rag,streamlit
GitHub 星标★ 6551
30天Star增速
HF 下载量
上线时间2023-11-16 00:00:00
最近更新2026-09-22 00:00:00
维护状态低维护
中文支持
访问方式
移动端支持
综合评分
收录时间2026-08-09
浏览次数2

使用教程

难度:入门 约 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"
    ' > .streamlit/secrets.toml
  5. 5启动 Streamlit 应用

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

    streamlit run 1__Home.py

关键配置

配置项必填说明示例
openai_keyOpenAI 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 = ""。

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

项目介绍

rags 是搜索知识领域的开源项目,由 run-llama 开发,2023 年首次发布。

在全站 13,014 个收录项目中,它的 GitHub 星标数(6,551)位列前 7%,在搜索知识分类的 581 个项目里位列前 9%。

项目已超过三个月没有代码更新,维护节奏明显放缓,最近一次代码更新于 2026-09-22。MIT许可证,可免费使用和部署。

它主要面向的使用场景是:业务人员快速查询销售报表。同类可对比的替代方案包括 LangChain、Haystack、Dify。

上一篇:BYO-LLM-WIKI

下一篇:bRAG-langchain

同类项目推荐

firecrawl 开源

网页抓取像喝水一样简单,开发者省下整周加班

The web data API to search, scrape, and interact at scale.

★ 183325 2026-08-09
contoso-chat 开源

一键跑通 Azure RAG 应用,从代码到评估部署全流程

This sample has the full End2End process of creating RAG application with Prompty an···

★ 766 2026-08-09
graphify 开源

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

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

★ 120493 2026-08-09
ragflow 开源

让大模型用上你的私有知识,搭建可靠的企业级RAG应用

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fu···

★ 91170 2026-08-09