🤖 企业RAG知识库

✨ 主要功能

🏗️ 技术架构

核心技术栈

系统流程

🚀 快速开始

1. 环境准备

# 克隆项目
git clone <your-repo-url>
cd enterprise-rag
# 创建虚拟环境(推荐)
python -m venv venv
source venv/bin/activate # Linux/Mac
# 或 venv\Scripts\activate # Windows
# 安装依赖
pip install -r requirements.txt
# 检查环境
python check_env.py

# Ubuntu/Debian 安装系统依赖
sudo apt-get update
sudo apt-get install python3-dev libpq-dev tesseract-ocr tesseract-ocr-chi-sim
# CentOS/RHEL
sudo yum install python3-devel postgresql-devel tesseract
# macOS
brew install postgresql tesseract tesseract-lang

2. 数据库配置

# Ubuntu/Debian
sudo apt-get install postgresql postgresql-contrib
sudo apt-get install postgresql-14-pgvector
# 或使用Docker
docker run -d \
 --name postgres-pgvector \
 -e POSTGRES_PASSWORD=postgres \
 -e POSTGRES_DB=rag \
 -p 5432:5432 \
 pgvector/pgvector:pg14

3. 配置环境变量

# 复制环境变量模板(如果不存在)
cp .env .env.local
# 编辑配置文件
vim .env

4. 初始化数据库

python init_db.py

5. 启动应用

# 方式1: 使用启动脚本
python run.py
# 方式2: 直接使用uvicorn
uvicorn main:app --host 0.0.0.0 --port 8000

6. 访问应用

🐳 Docker部署

使用Docker Compose(推荐)

# 一键部署
./deploy.sh
# 或手动执行
docker-compose up -d
# 查看服务状态
docker-compose ps
# 查看日志
docker-compose logs -f rag-app

手动Docker部署

# 构建镜像
docker build -t enterprise-rag .
# 启动PostgreSQL
docker run -d \
 --name postgres-pgvector \
 -e POSTGRES_PASSWORD=postgres \
 -e POSTGRES_DB=rag \
 -p 5432:5432 \
 pgvector/pgvector:pg14
# 启动应用
docker run -d \
 --name rag-app \
 --link postgres-pgvector:postgres \
 -e PG_HOST=postgres \
 -p 8000:8000 \
 -v ./models:/app/models \
 enterprise-rag

📖 使用指南

导入文档

# 通过API导入
curl -X POST "http://localhost:8000/documents/import" \
 -H "Content-Type: application/json" \
 -d '{"directory": "/path/to/your/documents"}'
# 增量同步
curl -X POST "http://localhost:8000/documents/sync" \
 -H "Content-Type: application/json" \
 -d '{"directory": "/path/to/your/documents"}'

智能问答

curl -X POST "http://localhost:8000/qa" \
 -H "Content-Type: application/json" \
 -d '{
 "question": "你的问题",
 "history": [["用户问题1", "助手回答1"]]
 }'

文档管理

# 获取文档列表
curl "http://localhost:8000/documents"
# 搜索文档
curl "http://localhost:8000/documents?search=关键词"
# 删除文档
curl -X DELETE "http://localhost:8000/documents/{document_id}"

⚙️ 配置说明

环境变量配置

支持的文档格式

🔧 开发指南

项目结构

enterprise-rag/
├── main.py # 主应用入口
├── config.py # 配置管理
├── db.py # 数据库连接
├── models.py # 数据模型
├── embedding.py # 向量化模块
├── rerank.py # 重排序模块
├── llm.py # 语言模型模块
├── document_loader.py # 文档加载器
├── utils.py # 工具函数
├── run.py # 启动脚本
├── init_db.py # 数据库初始化
├── check_env.py # 环境检查
├── requirements.txt # 依赖列表
├── .env # 环境变量配置
├── docker-compose.yml # Docker编排文件
├── Dockerfile # Docker镜像构建文件
├── deploy.sh # 部署脚本
├── api/ # API路由模块
│ ├── __init__.py
│ └── routes/ # 路由定义
│ ├── __init__.py
│ ├── documents.py # 文档管理接口
│ ├── qa.py # 问答接口
│ └── system.py # 系统接口
├── services/ # 业务服务层
│ ├── __init__.py
│ ├── document_service.py # 文档处理服务
│ ├── import_service.py # 导入服务
│ ├── qa_service.py # 问答服务
│ └── system_service.py # 系统服务
├── models/ # 数据模型目录
├── static/ # 静态文件
│ └── index.html # Web界面
├── .cursor/ # Cursor编辑器配置
├── .kiro/ # Kiro AI助手配置
├── .vscode/ # VSCode配置
└── README.md # 项目文档

API接口

🐛 故障排除

常见问题

日志查看

# 查看应用日志
tail -f rag_app.log
# 查看详细错误
python run.py --log-level debug
# Docker环境查看日志
docker-compose logs -f rag-app
# 实时监控系统状态
curl http://localhost:8000/system/stats

性能监控

# 系统健康状态
curl http://localhost:8000/system/health
# 详细系统信息(CPU、内存、磁盘)
curl http://localhost:8000/system/info
# 模型加载状态
curl http://localhost:8000/system/model_status
# 文档统计信息
curl http://localhost:8000/system/stats

📊 性能优化

硬件建议

配置优化

# 批量处理优化
export MAX_BATCH_SIZE=20
# 向量索引优化
export HNSW_M=16
export HNSW_EF_CONSTRUCTION=200

🤝 贡献指南

📄 许可证

🙏 致谢

📞 支持