# RAGnus

**Repository Path**: ervino/ragnus

## Basic Information

- **Project Name**: RAGnus
- **Description**: No description available
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2026-04-26
- **Last Updated**: 2026-05-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目名称 (RAGnus)

[![Python Version](https://shields.io)](https://python.org)
[![LLM](https://shields.io)](https://deepseek.com)
[![VectorDB](https://shields.io)](https://qdrant.tech)

一款高性能、生产级别的 RAG（检索增强生成）智能问答系统。基于 **BGE-M3** 全能嵌入模型与 **DeepSeek** 大模型开发，支持「稠密+稀疏」混合检索策略，完美兼顾轻量化部署与亿级数据扩展。

## 🌟 核心功能

- **混合检索方案**：集成 **BGE-M3** 模型，支持「稠密向量 + 稀疏向量 + RRF 重排」，大幅提升长文本和关键词检索精度。
- **灵活向量库选择**：
  - **LanceDB**：轻量级本地文件存储，适合快速原型开发或百万级向量规模。
  - **Qdrant (v1.7.1)**：高性能向量数据库，支持单机千万级至集群亿级向量规模。
- **强大 LLM 支持**：默认内置 **DeepSeek** 接口，提供更智能、更具性价比的对话体验。
- **一键便捷启动**：预置脚本，无需复杂的环境配置。

## 🛠️ 技术栈

- **核心语言**: Python 3.11 (推荐)
- **向量模型**: BGE-M3 (支持多模态、多语言、多粒度)
- **向量数据库**: LanceDB / Qdrant 1.7.1
- **大语言模型**: DeepSeek

## 🚀 快速上手

### 1. 克隆并进入 master 分支
```bash
git clone https://gitee.com/ervino/ragnus.git
cd ragnus
git checkout master
```

### 2. 环境准备
确保已安装 Python 3.11。建议使用虚拟环境：
```bash
python -m venv venv
source venv/bin/activate  # Linux/macOS
```

### 3. 启动项目
```bash
sh start.sh
```

Windows 环境部署指南

1. Qdrant 向量数据库部署

https://github.com/qdrant/qdrant

Qdrant 用于存储和检索向量数据。
下载安装：访问 Qdrant GitHub Releases 下载适用于 Windows 的最新二进制文件（通常为 qdrant-x86_64-pc-windows-msvc.zip）。
启动服务：
解压下载的压缩包。
在解压目录下打开终端（PowerShell 或 CMD）。
运行 ./qdrant.exe 启动服务。
参数配置：
默认情况下，Qdrant 运行在 localhost:6333。
同步配置：打开项目中的 config.py 文件，更新以下字段：
python
QDRANT_HOST = "localhost"
QDRANT_PORT = 6333


2. DeepSeek API 集成

https://platform.deepseek.com/usage

DeepSeek 提供大模型推理能力支持。
账号注册：访问 DeepSeek 开放平台 完成注册。
服务激活：
进入 费用中心 (Usage)。
点击充值（建议充值 10 元 RMB 即可满足前期开发调试需求）。
获取 Token：
前往 API Keys 页面。
创建一个新的 API Key 并立即复制保存（Key 仅在创建时显示一次）。
项目配置：
将获取的 Token 配置到项目的环境变量或 config.py 中：
python
DEEPSEEK_API_KEY = "your_api_key_here"

3. 启动 start.bat 等待各种模型下载大约6-7个G，最好有个代理会更快



## 📅 版本规划 (Roadmap)

- [x] **v1.0**: 实现混合检索流程，集成 DeepSeek 与 Qdrant/LanceDB。
- [ ] **v1.1 (Coming Soon)**: 深度适配阿里云生态。
  - 支持阿里云 DashScope LLM。
  - 适配阿里云 OpenSearch 向量检索。
  - 集成阿里云重排序 (Rerank) 服务。

---

## 🤝 贡献与反馈
欢迎提交 Issue 或 Pull Request 来完善本项目！