bRAG-langchain

跟着教程一步步搭出你自己的 RAG 问答系统

bRAG-langchain 是一个面向 RAG(检索增强生成)应用开发的教学型开源项目,提供从零构建 RAG 应用的完整指南。它基于 LangChain 框架,通过 Jupyter Notebook 形式逐步讲解 RAG 的核心概念、架构设计和实现细节,涵盖文档加载、文本分割、向量存储、检索器构建、提示词工程以及生成链路整合等关键环节。项目旨在帮助开发者理解 RAG 的工作原理,并快速上手构建自己的智能问答或对话系统。其内容组织清晰,代码可运行,适合作为学习 RAG 的入门教程,也适合作为开发时的参考手册。

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

项目数据

分类对话助手
开发团队bragai
所属国家
官网地址https://bragai.dev
定价模式unknown
价格说明定价信息待确认
访问状态
是否开源
开源协议NOASSERTION
主要语言Jupyter Notebook
技术栈/模型agentic-rag,ai,chatbot,llm,machine-learning,python,rag,retrieval-augmented-generation
GitHub 星标★ 4167
30天Star增速
HF 下载量
上线时间2024-11-16 00:00:00
最近更新2026-09-22 00:00:00
维护状态维护中
中文支持
访问方式
移动端支持
综合评分
收录时间2026-08-09
浏览次数3

使用教程

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

环境要求

  • Python 环境(用于创建虚拟环境并运行 Jupyter Notebook)
  • Jupyter Notebook 运行环境
  • OpenAI API Key(用于 LLM 与 Embedding)
  • Pinecone 账号与 API Key(向量数据库)
  • Cohere API Key(重排序等环节使用)

安装与启动步骤

  1. 1克隆项目仓库

    把 bRAG-langchain 仓库下载到本地,后续所有操作都在该目录内进行。

    git clone https://github.com/bragai/bRAG-langchain.git
    cd bRAG-langchain
  2. 2创建虚拟环境

    README 明确要求在虚拟环境中运行文件,避免依赖冲突。

    python -m venv .venv
    source .venv/bin/activate
  3. 3安装依赖

    使用仓库根目录的 requirements.txt 一次性安装全部依赖包。

    pip install -r requirements.txt
  4. 4复制环境变量模板

    把根目录的 .env.example 复制为 .env,作为密钥配置文件。

    cp .env.example .env
  5. 5填写 API 密钥

    编辑 .env,填入 OpenAI、LangSmith、Pinecone、Cohere 的真实密钥,密钥获取地址见 README 注释。

  6. 6运行 Notebook

    从 [1]_rag_setup_overview.ipynb 开始,按编号顺序依次运行 notebooks 目录下的各文件。

关键配置

配置项必填说明示例
OPENAI_API_KEYOpenAI 密钥,用于调用 LLM 与生成嵌入向量sk-xxxxxxxxxxxxxxxx
PINECONE_API_KEYPinecone 向量数据库密钥your-api-key
PINECONE_INDEX_NAMEPinecone 索引名称,用于相似度检索your-project-index
PINECONE_API_HOSTPinecone 索引的主机地址https://your-index.svc.region.pinecone.io
COHERE_API_KEYCohere 密钥,用于检索结果重排序your-api-key
LANGCHAIN_API_KEYLangSmith 密钥,用于链路追踪调试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

项目介绍

bRAG-langchain 是搜索知识领域的开源项目,由 bragai 开发,2024 年首次发布。

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

项目仍在小幅维护中,最近一次代码更新于 2026-09-22。从国内网络环境看,可直接访问。

它主要面向的使用场景是:初学者系统学习RAG原理与实现。同类可对比的替代方案包括 langchain、LlamaIndex、Haystack。

上一篇:rags

下一篇:autoflow

同类项目推荐

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