# rag-knowledge-base

**Repository Path**: itbyg/rag-knowledge-base

## Basic Information

- **Project Name**: rag-knowledge-base
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-26
- **Last Updated**: 2026-08-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 轻舟本地智能知识库系统

纯本地运行的 RAG（检索增强生成）知识库，支持文档导入、语义检索和 AI 回答生成。

## 功能

- 多格式文档导入（PDF、Word、TXT、Markdown）
- 智能语义检索 + 相关性过滤
- AI 生成回答（本地 Ollama + 联网大模型 API，当前支持 DeepSeek）
- **多轮对话**：会话管理、上下文记忆、历史压缩
- **答案评价**：👍👎 反馈，满意度统计
- **统计面板**：文档分布、问答趋势、检索热词
- **知识库导出**：ZIP 打包备份，支持导入恢复
- **文档预览**：模态弹窗在线查看
- **对话导出**：Markdown 格式，含参考来源
- 命令行 + Web 双界面

## 安装

```bash
# 1. 创建虚拟环境
python3 -m venv venv
source venv/bin/activate

# 2. 安装依赖
pip install -r requirements.txt

# 3. 安装命令行工具
pip install -e .
```

首次运行时会自动下载 BGE 中文 Embedding 向量模型（约 100MB），已内置国内镜像加速。

## 使用

激活虚拟环境后即可使用：

```bash
# 进入项目目录，激活环境
source venv/bin/activate

# 导入文档
rag-cli ingest docs/

# 提问
rag-cli ask "什么是RAG？"

# 管理知识库
rag-cli list          # 查看文档列表
rag-cli stats         # 统计信息
rag-cli clear         # 清空知识库
```

### Web 界面

```bash
source venv/bin/activate

# 启动服务（默认）
./start.sh

# 开发模式：自动 git pull + 重启
./start.sh watch

# 停止
./start.sh stop
```

浏览器打开 `http://localhost:7860`：

| 页面 | 路径 | 功能 |
|------|------|------|
| 智能问答 | `/` | 多轮对话、会话管理、Markdown 渲染、一键导出 |
| 文档管理 | `/manage` | 上传、下载、删除、预览、导出/导入备份 |
| 统计面板 | `/stats` | 数据概览、文档分布饼图、问答柱状图、热词、满意度 |
| 设置 | `/settings` | LLM 后端、模型名、API Key、检索参数、Ollama 状态 |

### API Key 配置

在设置页面填写联网模型 API Key（当前为 DeepSeek），自动保存到 `~/.rag-knowledge-base/.env`，也可手动编辑。

## 技术栈

- Embedding 向量模型：BAAI/bge-small-zh-v1.5（中英双语）
- 向量数据库：ChromaDB
- 文档解析：PyMuPDF（PDF）、python-docx（Word）
- LLM：本地 Ollama + 联网大模型 API（当前支持 DeepSeek）
- Web：Flask + Inter 字体
- 存储：SQLite（元数据、会话、评价）

## 硬件要求

- OS：Windows / macOS / Linux
- Python：3.8+
- CPU：2 核以上
- 内存：4GB 以上（纯检索 / 联网模型）；本地大模型建议 8GB+
- 磁盘：3GB 可用空间