
rags
用大白话跟数据聊天,自动出结果
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 6547
技术标签
使用教程
环境要求
- Python 3 环境(README 使用 python3 创建虚拟环境)
- 已安装 Poetry 包管理工具(需执行 poetry install)
- 一个可用的 OpenAI API Key(默认使用 OpenAI 作为构建与 RAG 智能体)
- 能访问 GitHub 克隆仓库的网络环境
安装与启动步骤
-
1克隆项目仓库
把 rags 仓库克隆到本地,克隆完成后进入项目文件夹,后续命令都在该目录内执行。
git clone https://github.com/run-llama/rags.git cd rags -
2创建虚拟环境
README 推荐为依赖创建独立虚拟环境,避免污染系统 Python 环境;创建后需自行激活(如 source .venv/bin/activate)。
python3 -m venv .venv -
3安装项目依赖
使用 Poetry 安装依赖,README 指定带 dev 依赖组安装,需等待依赖下载完成。
poetry install --with dev -
4配置 OpenAI 密钥
在项目根目录下的 .streamlit/secrets.toml 中写入 openai_key,README 要求该文件放在 home 文件夹下。
mkdir -p .streamlit printf 'openai_key = "sk-xxxxxxxx"\n' > .streamlit/secrets.toml -
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···
dstoolkit-text2sql-and-imageproc···
开源
把SQL数据和文档一起喂给RAG,快速搭企业问答应用
This repo accelerates development of RAG applications with rich data sources includi···
kaas
开源
把散乱笔记编译成可查询的 Markdown 知识库,供 AI 代理调用。
Turn scattered notes, docs and transcripts into a queryable Markdown wiki — an LLM ···
graphify
开源
整个代码库画成一张图,找问题一眼定位
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable k···
leettools-archive
开源
把大模型接进搜索流程,快速搭出带引用的智能问答原型
AI Search tools.
graphiti
开源
让AI智能体实时构建可追溯的知识图谱,告别静态RAG
Build Real-Time Knowledge Graphs for AI Agents
UltimateRAG
开源
按路线图从零到企业级,跑通并进阶 RAG 文档问答
一个按路线图逐步实现的 RAG 学习项目:从 Naive RAG → Advanced RAG → Agentic RAG → ···
nano-graphrag
开源
轻量可改的 GraphRAG,让你快速跑通并魔改知识图谱问答
A simple, easy-to-hack GraphRAG implementation
patent-literature-search-mcp
开源
一个接口搜遍全球专利和学术文献,让AI帮你做创新情报分析
Search global patents across WIPO, EPO, USPTO, CNIPA, JPO, KIPO and other authoritie···