项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 4197
使用教程
环境要求
- Python 环境(用于创建虚拟环境并运行 Jupyter Notebook)
- Jupyter Notebook 运行环境
- OpenAI API Key(用于 LLM 与 Embedding)
- Pinecone 账号与 API Key(向量数据库)
- Cohere API Key(重排序等环节使用)
安装与启动步骤
-
1克隆项目仓库
把 bRAG-langchain 仓库下载到本地,后续所有操作都在该目录内进行。
git clone https://github.com/bragai/bRAG-langchain.git cd bRAG-langchain -
2创建虚拟环境
README 明确要求在虚拟环境中运行文件,避免依赖冲突。
python -m venv .venv source .venv/bin/activate -
3安装依赖
使用仓库根目录的 requirements.txt 一次性安装全部依赖包。
pip install -r requirements.txt -
4复制环境变量模板
把根目录的 .env.example 复制为 .env,作为密钥配置文件。
cp .env.example .env -
5填写 API 密钥
编辑 .env,填入 OpenAI、LangSmith、Pinecone、Cohere 的真实密钥,密钥获取地址见 README 注释。
-
6运行 Notebook
从 [1]_rag_setup_overview.ipynb 开始,按编号顺序依次运行 notebooks 目录下的各文件。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | OpenAI 密钥,用于调用 LLM 与生成嵌入向量 | sk-xxxxxxxxxxxxxxxx |
PINECONE_API_KEY | 是 | Pinecone 向量数据库密钥 | your-api-key |
PINECONE_INDEX_NAME | 是 | Pinecone 索引名称,用于相似度检索 | your-project-index |
PINECONE_API_HOST | 是 | Pinecone 索引的主机地址 | https://your-index.svc.region.pinecone.io |
COHERE_API_KEY | 是 | Cohere 密钥,用于检索结果重排序 | your-api-key |
LANGCHAIN_API_KEY | 否 | LangSmith 密钥,用于链路追踪调试 | your-api-key |
如何确认成功
按顺序运行 [1]_rag_setup_overview.ipynb,各单元格无报错并返回模型生成的回答,即表示环境配置成功。
常见问题
Q:必须申请哪些第三方密钥?
A:README 列出四家:OpenAI、LangSmith、Pinecone、Cohere,均需在对应官网注册获取后填入 .env 文件。
Q:一定要按顺序运行 Notebook 吗?
A:是的。README 要求从 [1]_rag_setup_overview.ipynb 开始,按编号 1 到 5 顺序学习并运行。
Q:向量数据库只能用 Pinecone 吗?
A:不一定。第 1 个 Notebook 说明中同时提到了 ChromaDB 与 Pinecone 两种向量存储方案。
Q:只想快速跑通一个 RAG 聊天机器人怎么办?
A:可直接打开 full_basic_rag.ipynb,README 称其提供了可完全自定义的 RAG 聊天机器人样板代码。
注意事项
- README 强调所有文件必须在虚拟环境中运行。
- 项目内容是教学型 Notebook,需逐个执行单元格而非一条命令启动服务。
- .env 中含真实密钥,不要将其提交到 Git 仓库。
- 官网 bragai.dev 在 README 中标注为即将上线。
核心亮点
- Notebook 形式手把手教学,代码可直接运行,学习曲线平缓
- 覆盖 RAG 全流程,从文档处理到检索生成,知识点系统完整
- 基于 LangChain 生态,与主流工具链无缝衔接,实用性强
不足之处
- 内容偏教学演示,生产级性能优化和工程化部署细节不足
- 文档/社区待观察
适用场景
- 初学者系统学习 RAG 原理与实现
- 快速搭建 RAG 原型验证业务可行性
- 作为企业内部 RAG 技术培训教材
替代项目
langchain、LlamaIndex、Haystack
同类项目推荐
bravegpt
开源
在 Brave 搜索里直接聊 AI,边搜边问,摘要即时看。
AI chat & search summaries in Brave Search, powered by the latest LLMs
cloudflare-rag
开源
上传 PDF,即刻在 Cloudflare 边缘开启智能问答
Fullstack "Chat with your PDFs" RAG (Retrieval Augmented Generation) app built fully···
distil-text2sql
开源
用大白话问数据库,自动出 SQL 和结果
Query your data in plain English with a fine-tuned Text2SQL model
NanoSage
开源
本地 LLM 驱动,递归搜索+知识图谱,快速吃透复杂主题
Local LLM Powered Recursive Search & Smart Knowledge Explorer
LEANN
开源
让个人设备也能跑起又快又准的私有 RAG,存储省 97%。
[MLsys2026 Best Paper]: https://arxiv.org/abs/2506.08276. RAG on Everything with LEA···
deep-thinking-rag
开源
让RAG学会深度思考,复杂问题一次答对
A Deep Thinking RAG Pipeline to Solve Complex Queries
rag-demystified
开源
从零手写 RAG 管道,搞懂每个细节,快速搭建自己的检索生成系统。
An LLM-powered advanced RAG pipeline built from scratch
RAG_Hack
开源
跟着微软示例,快速搭出你的 RAG 应用
Hack Together: RAG Hack | Register, Learn, Hack
llm-wiki-compiler
开源
丢进原始资料,自动生成互联 Wiki 知识库
The knowledge compiler. Raw sources in, interlinked wiki out. Inspired by Karpathy's···
