30c7bda389
- Removed multiple failed document entries from `documents.json`. - Added a new document entry with updated metadata and changed the index name to `regulations_dense_1024_v2`. - Updated architecture documentation to reflect changes in the Milvus collection name. - Adjusted requirements by removing the sqlalchemy dependency. - Modified test cases to align with new document structure and naming conventions. - Introduced a new test file for Milvus vector index runtime recovery and error handling. - Updated assertions in various test files to ensure compatibility with the new schema.
150 lines
4.0 KiB
Markdown
150 lines
4.0 KiB
Markdown
# AI+合规智能中枢 - 法律法规文档解析入库
|
||
|
||
面向车企与工厂的合规智能平台，实现法规文档的解析、分块、嵌入和向量存储。
|
||
|
||
## MVP功能
|
||
|
||
本次实现的核心功能（最小可用版本）：
|
||
|
||
- ✅ PDF/DOC/DOCX 文档解析（阿里云文档智能）
|
||
- ✅ 基于阿里云 `vector_chunks` 的统一切片
|
||
- ✅ OpenAI 兼容 embedding（`text-embedding-v3`，1024维）
|
||
- ✅ Milvus 向量数据库存储与 dense-only 检索
|
||
- ✅ FastAPI接口封装
|
||
|
||
## 项目结构
|
||
|
||
```text
|
||
AIRegulation-DocAnalysis-Demo/
|
||
├── backend/
|
||
│ ├── app/
|
||
│ │ ├── api/ # FastAPI 接口层
|
||
│ │ ├── application/ # 用例编排层
|
||
│ │ ├── domain/ # 领域模型与稳定端口
|
||
│ │ ├── infrastructure/ # MinIO / Milvus / 阿里云 / embedding / session 适配
|
||
│ │ ├── shared/ # 组合根、配置无关 wiring 与横切支撑
|
||
│ │ ├── config/ # 配置与日志
|
||
│ │ ├── services/ # 迁移期 legacy façade，不是新增业务逻辑默认落点
|
||
│ │ ├── workflows/ # 迁移期 legacy workflow，不是新增业务逻辑默认落点
|
||
│ │ └── workers/
|
||
│ ├── requirements.txt
|
||
│ └── main.py
|
||
├── frontend/ # Vite React 前端
|
||
├── tests/ # 根级测试，导入 backend/app
|
||
├── docker/
|
||
│ └── docker-compose.yml
|
||
├── pyproject.toml
|
||
└── .env.example
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
### 1. 安装依赖
|
||
|
||
```bash
|
||
./dev.sh setup
|
||
```
|
||
|
||
### 2. 启动Milvus向量数据库
|
||
|
||
```bash
|
||
cd docker
|
||
docker-compose up -d
|
||
```
|
||
|
||
等待Milvus启动完成（约30秒）：
|
||
```bash
|
||
docker-compose logs -f milvus
|
||
```
|
||
|
||
### 3. 启动API服务
|
||
|
||
```bash
|
||
./dev.sh start api --foreground
|
||
```
|
||
|
||
访问API文档：http://localhost:8000/docs
|
||
|
||
## API接口
|
||
|
||
## Backend Architecture
|
||
|
||
- Backend 架构规范文档：`docs/architecture/backend-project-architecture.md`
|
||
- Backend 迁移 RFC：`docs/rfc/backend-api-parsing-embedding-migration-requirements.md`
|
||
- 后续 backend 新增功能、重构和技术替换必须同时满足 RFC 与架构文档。
|
||
- `backend/app/services/*` 与 `backend/app/workflows/*` 当前属于迁移期遗留目录，除迁移或兼容修复外，不应继续承载新的业务编排。
|
||
|
||
### 上传文档
|
||
|
||
```bash
|
||
curl -X POST http://localhost:8000/api/v1/documents/upload \
|
||
-F "file=@your_regulation.pdf" \
|
||
-F "doc_name=GB 7258-2017" \
|
||
-F "regulation_type=车辆安全"
|
||
```
|
||
|
||
### 检索法规
|
||
|
||
```bash
|
||
curl -X POST http://localhost:8000/api/v1/knowledge/search \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"query": "机动车安全技术要求", "top_k": 10}'
|
||
```
|
||
|
||
## 技术栈
|
||
|
||
| 类别 | 技术 |
|
||
|------|------|
|
||
| 文档解析 | 阿里云文档智能 + python-docx |
|
||
| 分块策略 | 阿里云 `vector_chunks` |
|
||
| 嵌入模型 | `text-embedding-v3`（1024维 Dense） |
|
||
| 向量数据库 | Milvus 2.4（本地Docker部署） |
|
||
| 检索方式 | Dense-only 检索 |
|
||
| API框架 | FastAPI |
|
||
|
||
## 配置
|
||
|
||
创建 `.env` 文件（参考 `.env.example`）：
|
||
|
||
```env
|
||
# Milvus配置
|
||
MILVUS_HOST=localhost
|
||
MILVUS_PORT=19530
|
||
|
||
# 阿里云文档解析
|
||
ALIBABA_ACCESS_KEY_ID=your_aliyun_access_key_id
|
||
ALIBABA_ACCESS_KEY_SECRET=your_aliyun_access_key_secret
|
||
PARSER_BACKEND=aliyun
|
||
CHUNK_BACKEND=aliyun
|
||
|
||
# embedding 配置
|
||
EMBEDDING_MODEL=text-embedding-v3
|
||
EMBEDDING_DIM=1024
|
||
EMBEDDING_API_KEY=your_embedding_api_key_here
|
||
|
||
# 分块配置
|
||
CHUNK_SIZE=512
|
||
```
|
||
|
||
## 后续迭代（不在本次MVP范围）
|
||
|
||
- LLM摘要生成（当前上传主链路默认不生成）
|
||
- 文档上传UI界面
|
||
- 混合检索问答功能
|
||
- 法规变更监控与自动更新
|
||
|
||
## 解析产物
|
||
|
||
上传成功后，系统会把阿里云解析的中间结果持久化到 MinIO：
|
||
|
||
- `artifacts/{doc_id}/layouts.json`
|
||
- `artifacts/{doc_id}/structure_nodes.json`
|
||
- `artifacts/{doc_id}/semantic_blocks.json`
|
||
- `artifacts/{doc_id}/vector_chunks.json`
|
||
|
||
当前默认 Milvus collection 为 `regulations_dense_1024_v2`。
|
||
|
||
## 许可证
|
||
|
||
MIT License
|