chore: 清理过期数据库配置并添加新需求文档
- 删除旧的数据库连接配置文件 - 添加上传 API 需求文档 - 添加知识库 API 需求文档 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
96
team-require/api/upload-api.md
Normal file
96
team-require/api/upload-api.md
Normal file
@@ -0,0 +1,96 @@
|
||||
# 文件上传 API
|
||||
|
||||
## 基础信息
|
||||
|
||||
| 项目 | 说明 |
|
||||
|------|------|
|
||||
| 基础URL | `http://localhost:8082` |
|
||||
| 上传模式 | local / minio（配置决定） |
|
||||
|
||||
## 配置说明
|
||||
|
||||
```yaml
|
||||
# config.yaml
|
||||
upload_mode: "local" # 上传模式：local 或 minio
|
||||
upload_local_path: "resource/files" # 本地存储路径
|
||||
server_base_url: "http://localhost:8082" # 服务器基础URL
|
||||
|
||||
# MinIO 配置（upload_mode 为 minio 时需要）
|
||||
minio_endpoint: "localhost:9000"
|
||||
minio_access_key: "your-access-key"
|
||||
minio_secret_key: "your-secret-key"
|
||||
minio_bucket: "x-agents"
|
||||
minio_use_ssl: false
|
||||
```
|
||||
|
||||
## 接口列表
|
||||
|
||||
### 1. 上传文件
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
POST /upload
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| file | File | 是 | 要上传的文件 |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"url": "http://localhost:8082/files/abc123.pdf",
|
||||
"fileKey": "abc123",
|
||||
"message": "Upload successful"
|
||||
}
|
||||
```
|
||||
|
||||
**错误响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"message": "File too large (max 100MB)"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. 删除文件
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
DELETE /upload/:filename
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| filename | String | 是 | 文件名（不含路径） |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "File deleted"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. 访问文件（仅本地模式）
|
||||
|
||||
文件上传后，本地模式下可通过以下 URL 直接访问：
|
||||
|
||||
```
|
||||
GET /files/{filename}
|
||||
```
|
||||
|
||||
例如：`http://localhost:8082/files/abc123.pdf`
|
||||
|
||||
> 注意：MinIO 模式返回的是预签名 URL，有效期 24 小时。
|
||||
354
team-require/web/knowledge-base-api.md
Normal file
354
team-require/web/knowledge-base-api.md
Normal file
@@ -0,0 +1,354 @@
|
||||
# 知识库创建 API
|
||||
|
||||
## 基础信息
|
||||
|
||||
| 项目 | 说明 |
|
||||
|------|------|
|
||||
| 基础URL | `http://localhost:8082` |
|
||||
| 前端页面 | Knowledge Base 创建弹窗 |
|
||||
|
||||
## 接口列表
|
||||
|
||||
### 1. 创建知识库
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
POST /api/knowledge/create
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| name | String | 是 | 知识库名称 |
|
||||
| description | String | 否 | 知识库描述 |
|
||||
| llm_model_id | String | 是 | LLM 模型 ID（来自 model 表） |
|
||||
| embedding_model_id | String | 是 | Embedding 模型 ID（来自 model 表） |
|
||||
| parsing_config | Object | 是 | 解析配置 |
|
||||
| - engine | String | 是 | 解析引擎：markitdown / docling |
|
||||
| - docling_url | String | 条件必填 | Docling 服务 URL（engine=docling 时必填） |
|
||||
| - enable_pdf | Boolean | 否 | 是否启用 PDF 解析（默认 true） |
|
||||
| - pandoc | Boolean | 否 | 是否启用 Pandoc（默认 true） |
|
||||
|
||||
**请求示例**
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "产品文档知识库",
|
||||
"description": "用于存储产品手册和文档",
|
||||
"llm_model_id": "model_001",
|
||||
"embedding_model_id": "model_002",
|
||||
"parsing_config": {
|
||||
"engine": "markitdown",
|
||||
"enable_pdf": true,
|
||||
"pandoc": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
或使用 Docling：
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "产品文档知识库",
|
||||
"description": "用于存储产品手册和文档",
|
||||
"llm_model_id": "model_001",
|
||||
"embedding_model_id": "model_002",
|
||||
"parsing_config": {
|
||||
"engine": "docling",
|
||||
"docling_url": "http://localhost:8501",
|
||||
"enable_pdf": true,
|
||||
"pandoc": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**成功响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"id": "kb_abc123",
|
||||
"message": "Knowledge base created successfully"
|
||||
}
|
||||
```
|
||||
|
||||
**错误响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"message": "LLM model not found"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. 获取知识库列表
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
GET /api/knowledge/list
|
||||
```
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"id": "kb_001",
|
||||
"name": "产品文档知识库",
|
||||
"description": "用于存储产品手册",
|
||||
"llm_model_id": "model_001",
|
||||
"embedding_model_id": "model_002",
|
||||
"status": "active",
|
||||
"document_count": 15,
|
||||
"chunk_count": 156,
|
||||
"created_at": "2024-01-15T10:30:00Z",
|
||||
"updated_at": "2024-01-15T10:30:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. 获取知识库详情
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
GET /api/knowledge/:id
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": "kb_001",
|
||||
"name": "产品文档知识库",
|
||||
"description": "用于存储产品手册",
|
||||
"llm_model_id": "model_001",
|
||||
"embedding_model_id": "model_002",
|
||||
"parsing_config": {
|
||||
"engine": "markitdown",
|
||||
"enable_pdf": true,
|
||||
"pandoc": true
|
||||
},
|
||||
"status": "active",
|
||||
"document_count": 15,
|
||||
"chunk_count": 156,
|
||||
"created_at": "2024-01-15T10:30:00Z",
|
||||
"updated_at": "2024-01-15T10:30:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 4. 删除知识库
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
DELETE /api/knowledge/:id
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Knowledge base deleted"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 5. 获取知识库下的文档列表
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
GET /api/knowledge/:id/documents
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
|
||||
**查询参数**
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| status | String | 否 | 过滤状态：all / parsed / parsing / failed |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"id": "doc_001",
|
||||
"name": "产品手册_v2.0.pdf",
|
||||
"file_size": 2516582,
|
||||
"status": "parsed",
|
||||
"chunk_count": 156,
|
||||
"uploaded_at": "2024-01-15T10:30:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 6. 上传文档到知识库
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
POST /api/knowledge/:id/documents
|
||||
Content-Type: multipart/form-data
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
| file | File | 是 | 要上传的文件 |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"dataid": "doc_001",
|
||||
": {
|
||||
" "name": "产品手册_v2.0.pdf",
|
||||
"status": "parsing"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 7. 删除知识库文档
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
DELETE /api/knowledge/:id/documents/:doc_id
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
| doc_id | String | 是 | 文档 ID |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Document deleted"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 8. 重新解析文档
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
POST /api/knowledge/:id/documents/:doc_id/reparse
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
| doc_id | String | 是 | 文档 ID |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"message": "Document reparse started"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 9. 获取文档预览内容
|
||||
|
||||
**请求**
|
||||
|
||||
```
|
||||
GET /api/knowledge/:id/documents/:doc_id/preview
|
||||
```
|
||||
|
||||
| 参数 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| id | String | 是 | 知识库 ID |
|
||||
| doc_id | String | 是 | 文档 ID |
|
||||
| page | Number | 否 | 页码（默认 1） |
|
||||
|
||||
**响应**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"total_pages": 3,
|
||||
"current_page": 1,
|
||||
"content": "第一章 产品介绍\n\n欢迎使用我们的产品手册..."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 数据库表设计（参考）
|
||||
|
||||
### knowledge_base 表
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| id | String | 主键 |
|
||||
| name | String | 知识库名称 |
|
||||
| description | Text | 描述 |
|
||||
| llm_model_id | String | LLM 模型 ID |
|
||||
| embedding_model_id | String | Embedding 模型 ID |
|
||||
| parsing_config | JSON | 解析配置 |
|
||||
| status | String | 状态：active / inactive |
|
||||
| document_count | Integer | 文档数量 |
|
||||
| chunk_count | Integer | 切片数量 |
|
||||
| created_at | Timestamp | 创建时间 |
|
||||
| updated_at | Timestamp | 更新时间 |
|
||||
|
||||
### knowledge_document 表
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| id | String | 主键 |
|
||||
| knowledge_base_id | String | 知识库 ID |
|
||||
| name | String | 文档名称 |
|
||||
| file_key | String | 文件存储 key |
|
||||
| file_size | BigInteger | 文件大小 |
|
||||
| status | String | 状态：parsing / parsed / failed |
|
||||
| chunk_count | Integer | 切片数量 |
|
||||
| uploaded_at | Timestamp | 上传时间 |
|
||||
@@ -2,6 +2,16 @@
|
||||
|
||||
## 2026年3月
|
||||
|
||||
### 2026-03-08
|
||||
|
||||
- [ ] **知识库（Knowledge Base）API** - 后端待实现
|
||||
- 创建知识库、获取列表、获取详情、删除
|
||||
- 上传文档、删除文档、重新解析
|
||||
- 获取文档预览内容
|
||||
- 详细需求：[knowledge-base-api.md](./knowledge-base-api.md)
|
||||
|
||||
---
|
||||
|
||||
### 2026-03-07
|
||||
|
||||
- [x] **DDL 编辑功能** - 后端已完成 ✔
|
||||
Reference in New Issue
Block a user