RAG 知识库系统

魏群
110 阅读4分钟

RAG 知识库系统

项目地址

❤️喜欢ai-chat-rag这个项目？那就给它星星🌟吧

一个基于 FastAPI + WebSocket + ChromaDB +LLM 的智能检索增强生成（RAG）知识库系统，支持文档上传、智能搜索和对话式问答。

RAG系统

🌟 功能特性

📚 文档管理

  • 多格式支持: 支持 TXT, MD, HTML 等格式
  • 智能分块: 自动将文档分割成语义完整的文本块
  • 向量存储: 使用 ChromaDB 存储文档向量嵌入
  • 重复检测: 防止重复上传相同文档
  • 文档预览: 在线查看文档内容
  • 搜索功能: 关键词搜索文档内容

💬 智能对话

  • WebSocket 实时通信: 提供流畅的对话体验
  • 多文档选择: 可选择多个文档作为知识来源
  • 上下文感知: 基于上传的文档内容进行智能回答
  • 流式响应: 实时显示AI生成内容
  • Markdown 渲染: 支持富文本格式显示

🔍 高级检索

  • 向量召回: 结合嵌入相似度和语义检索
  • 重排优化: 使用交叉编码器提升结果相关性
  • 中文优化: 针对中文内容优化的嵌入模型

🛠️ 技术栈

后端

  • FastAPI: 高性能 Python Web 框架
  • WebSocket: 实时双向通信
  • ChromaDB: 向量数据库
  • Sentence Transformers: 文本嵌入模型
  • Cross Encoder: 重排模型
  • SQLite: 文档元数据存储

前端

  • HTML5 + CSS3: 现代化响应式界面
  • JavaScript ES6+: 交互逻辑
  • WebSocket API: 实时通信
  • Marked.js: Markdown 渲染
  • Font Awesome: 图标库

AI 集成

  • DeepSeek API: 大语言模型服务
  • 中文优化模型: shibing624/text2vec-base-chinese
  • 重排模型: cross-encoder/mmarco-mMiniLMv2-L12-H384-v1

📦 安装部署

环境要求

  • Python 3.8+
  • pip 20.0+

1. 克隆项目

git clone https://github.com/Anthonybuer182/ai-chat-rag.git
cd ai-chat-rag

2. 安装依赖

pip install -r requirements.txt

3. 配置环境变量

创建 .env 文件并设置 DeepSeek API 密钥：

DEEPSEEK_API_KEY=your_deepseek_api_key_here

注意: 项目使用 DeepSeek API，需要注册并获取 API 密钥

获取 API 密钥: 访问 DeepSeek 平台 注册账号并获取 API 密钥

4. 启动应用

python main.py

应用将在 http://0.0.0.0:8000 启动，访问该地址即可使用。

5. API 文档

访问 http://0.0.0.0:8000/docs 查看完整的 API 文档。

🚀 使用指南

上传文档

  1. 点击"文档管理"标签页
  2. 拖拽文件到上传区域或点击"选择文件"
  3. 系统自动处理文档并构建向量索引

智能对话

  1. 点击"智能聊天"标签页
  2. 选择要参考的文档（可选）
  3. 输入问题并发送
  4. AI 将基于所选文档内容回答

文档搜索

  1. 在文档管理页面点击搜索图标
  2. 输入关键词搜索文档内容
  3. 查看相关度排序的搜索结果

📁 项目结构

目录结构

ai-chat-rag/
├── main.py                 # 主应用文件
├── requirements.txt        # 依赖包列表
├── text_chunk.py          # 文本分块处理
├── app.log                # 应用日志
├── .gitignore            # Git 忽略文件
├── data/                 # 数据存储目录
│   ├── chroma/          # ChromaDB 数据
│   └── knowledge_base.db # SQLite 数据库
├── static/              # 静态文件目录
│   └── uploads/         # 上传文件存储
├── templates/           # 模板文件
│   └── index.html       # 前端页面
└── utils/               # 工具模块
    ├── __init__.py
    └── stream_llm.py    # LLM 流式处理

image.png

flowchart TD
    %% 左侧列 - 文档处理流程
    subgraph LeftColumn [文档处理流程]
        direction TB
        A1[📄 文档导入] --> A2[文档加载与解析]
        A2 --> A3[文本分割<br>Text Splitting]
        A3 --> A4[文本向量化<br>Embedding]
        A4 --> A5[向量存储]
    end

    %% 中间列 - 向量数据库
    subgraph MiddleColumn [向量数据库]
        direction TB
        DB[(向量数据库<br>Vector Store)]
    end
    
    %% 右侧列 - 查询与响应流程
    subgraph RightColumn [查询与响应流程]
        direction TB
        B1[❓ 用户输入查询] --> B3[查询向量化<br>Query Embedding]
        B3 --> B4[相似性检索<br>Similarity Search]
        B4 --> C1[重排序<br>Re-ranking]
        C1 --> D1[组合查询与上下文]
        D1 --> D2[LLM生成回答<br>Large Language Model]
        D2 --> D3[✅ 返回最终答案]
    end
    
    %% 连接左侧和中间列
    A5 --> DB
    
    %% 连接中间列和右侧列
    DB --> B4
    
    %% 样式定义
    classDef docProcess fill:#E3F2FD,stroke:#0D47A1,stroke-width:2px,color:#0D47A1;
    classDef vectorDB fill:#FFEBEE,stroke:#C62828,stroke-width:2px,color:#C62828;
    classDef queryProcess fill:#E8F5E9,stroke:#2E7D32,stroke-width:2px,color:#2E7D32;
    classDef rerankProcess fill:#FFF8E1,stroke:#FF8F00,stroke-width:2px,color:#FF8F00;
    classDef responseProcess fill:#F3E5F5,stroke:#4A148C,stroke-width:2px,color:#4A148C;
    
    %% 应用样式
    class A1,A2,A3,A4,A5 docProcess;
    class DB vectorDB;
    class B1,B2,B3,B4 queryProcess;
    class C1,C2 rerankProcess;
    class D1,D2,D3 responseProcess;

🔧 配置说明

模型配置

  • 嵌入模型: shibing624/text2vec-base-chinese (中文优化)
  • 重排模型: cross-encoder/mmarco-mMiniLMv2-L12-H384-v1
  • LLM 模型: deepseek-chat (通过 DeepSeek API)

文本分块参数

  • 块大小: 150 字符
  • 重叠大小: 30 字符
  • 分隔符: 段落 > 句子 > 单词 > 字符

检索参数

  • 召回数量: 10 条
  • 重排数量: 5 条
  • 相似度阈值: 动态计算

🛠️ 开发指南

添加新功能

  1. 在 main.py 中添加新的 API 端点
  2. 在前端 templates/index.html 中添加相应界面
  3. 更新文档和测试

自定义模型

修改 main.py 中的模型配置：

# 更换嵌入模型
embedding_model = SentenceTransformer('your-model-name')

# 更换重排模型  
reranker = CrossEncoder('your-reranker-model')

# 更换 LLM 服务
async def stream_llm(messages):
    # 实现自定义 LLM 调用

🤝 贡献指南

  1. Fork 项目
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

📄 许可证

本项目基于 MIT 许可证 - 查看 LICENSE 文件了解详情

🙏 致谢

📞 支持

如有问题或建议，请通过以下方式联系：

🎯 路线图

  • 支持多语言界面
  • 支持更多文件格式解析
  • 集成更多 LLM 提供商
  • 支持自主配置模型参数

注意: 使用前请确保已配置正确的 API 密钥，并遵守相关服务的使用条款。

恳求: ❤️喜欢ai-chat-rag这个项目？那就给它星星🌟吧

avatar
文章
阅读
粉丝