# notes-agent-pub

**Repository Path**: emptypty/notes-agent-pub

## Basic Information

- **Project Name**: notes-agent-pub
- **Description**: notes-agent-pub
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-05-07
- **Last Updated**: 2026-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 电商知识库管理系统

基于 RAG（检索增强生成）的电商客服知识库管理平台，提供知识库维护、智能问答测试和系统管理功能，面向客服团队（< 50 人）的私有化部署方案。

## 技术架构

```
┌─────────────────────────────────────────────────────────┐
│                      前端 (kb-web)                       │
│   Vue 3 + TypeScript + Element Plus + Pinia + Vite      │
└──────────────────────────┬──────────────────────────────┘
                           │ HTTP / SSE
┌──────────────────────────▼──────────────────────────────┐
│                    后端 (kb-admin)                       │
│          Spring Boot 3.2.5 + Java 17                    │
│   ┌──────────┐  ┌──────────┐  ┌──────────────────┐     │
│   │ Security │  │ MyBatis  │  │   RAG Pipeline   │     │
│   │  + JWT   │  │  Plus    │  │ Embedding → LLM  │     │
│   └──────────┘  └──────────┘  └──────────────────┘     │
└───────┬──────────────┬───────────────┬─────────────────┘
        │              │               │
   ┌────▼────┐   ┌────▼────┐   ┌──────▼──────┐
   │ MySQL   │   │  Redis  │   │   Milvus    │
   │  8.0    │   │   7     │   │   v2.4      │
   │ 业务数据 │   │ 缓存/会话│   │ 向量检索    │
   └─────────┘   └─────────┘   └─────────────┘
                                    │
                    ┌───────────────┼───────────────┐
                    │                               │
              ┌─────▼─────┐                 ┌───────▼───────┐
              │ 智谱 GLM-4.5│               │ 腾讯混元       │
              │  对话生成   │               │ 文本向量化     │
              └───────────┘                 └───────────────┘
```

## 技术栈

| 层级 | 技术 | 说明 |
|------|------|------|
| 前端 | Vue 3 + TypeScript | Composition API + `<script setup>` |
| UI 框架 | Element Plus | 中文组件库 |
| 状态管理 | Pinia | 用户认证状态 |
| 富文本编辑 | WangEditor v5 | 文档内容编辑 |
| 后端框架 | Spring Boot 3.2.5 | Java 17 |
| ORM | MyBatis-Plus | 逻辑删除、驼峰映射 |
| 数据库 | MySQL 8.0 | Flyway 版本管理 |
| 向量数据库 | Milvus v2.4 | 语义检索 |
| 缓存 | Redis 7 | Session / 缓存 |
| LLM | 智谱 GLM-4.5 | 流式对话生成 |
| Embedding | 腾讯混元 | 文本向量化 |
| 认证 | Spring Security + JWT | 24 小时过期 |
| 部署 | Docker Compose | 私有化部署 |

## 核心功能

### 1. 知识库管理

支持知识库的创建、编辑、删除和搜索。每个知识库可包含多篇文档和多组问答对。

![知识库列表](docs/screenshots/05-kb-list-page.png)

![知识库数据展示](docs/screenshots/06-kb-list-items.png)

![知识库搜索](docs/screenshots/07-kb-search.png)

![创建知识库](docs/screenshots/15-create-kb-filled.png)

![创建成功](docs/screenshots/16-create-kb-result.png)

### 2. RAG 智能问答

- 文档发布后自动进行文本分块（500 字符，50 字符重叠）
- 通过腾讯混元 API 生成向量并存入 Milvus
- 用户提问时检索 Top-5 相关文档片段
- 智谱 GLM-4.5 流式生成回答（SSE）
- 支持人工评分和质量追踪

### 3. 用户登录

JWT 认证，支持 admin / editor / viewer 三种角色。

![登录页面](docs/screenshots/01-login-page.png)

### 4. 系统管理

**分类管理**

![分类管理](docs/screenshots/17-category-management.png)

![创建分类](docs/screenshots/18-create-category-dialog.png)

**用户管理**

![用户管理](docs/screenshots/19-user-management.png)

![创建用户](docs/screenshots/20-create-user-dialog.png)

## RAG 数据流

```
                    知识录入流程
                    ═══════════
  文档/问答 ──► 文本分块(500字/块) ──► 腾讯混元 Embedding ──► Milvus 向量存储
                                                                │
                                                          MySQL 元数据

                    智能问答流程
                    ═══════════
  用户提问 ──► 腾讯混元 Embedding ──► Milvus 向量检索(Top-5)
                                          │
                              组装 Prompt(系统指令 + 检索结果 + 问题)
                                          │
                              智谱 GLM-4.5 流式生成 ──► SSE 回答
```

## 项目结构

```
notes-agent/
├── kb-admin/                          # 后端 (Spring Boot)
│   ├── src/main/java/com/ecommerce/kb/
│   │   ├── config/                    # 配置类 (Milvus, Security, CORS)
│   │   ├── common/                    # 通用工具 (Result, Exception, JWT)
│   │   └── modules/
│   │       ├── knowledge/             # 知识库模块 (CRUD, 文档, 问答对)
│   │       ├── chat/                  # RAG 问答模块 (RagService, Milvus, Zhipu)
│   │       ├── test/                  # 测试记录模块
│   │       └── system/                # 系统管理 (用户, 分类)
│   └── src/main/resources/
│       ├── application.yml            # 应用配置
│       └── db/migration/              # Flyway 数据库迁移
├── kb-web/                            # 前端 (Vue 3)
│   └── src/
│       ├── views/
│       │   ├── Login.vue              # 登录页
│       │   ├── knowledge/             # 知识库页面
│       │   ├── test/                  # 问答测试页面
│       │   └── system/               # 系统管理页面
│       ├── components/               # 公共组件 (ChatPanel, QaPairDialog)
│       ├── api/                      # API 请求封装
│       ├── stores/                   # Pinia 状态管理
│       └── router/                   # 路由配置 (含鉴权守卫)
├── docker/
│   └── infrastructure/
│       └── docker-compose.yml        # Milvus 等基础设施
└── docs/                             # 文档和截图
```

## 快速开始

### 环境要求

- Java 17+
- Node.js 18+
- MySQL 8.0
- Redis 7
- Milvus v2.4

### 启动基础设施

```bash
cd docker/infrastructure
docker-compose up -d
```

### 启动后端

```bash
cd kb-admin
mvn spring-boot:run
# 服务地址: http://localhost:6001
```

### 启动前端

```bash
cd kb-web
npm install
npm run dev
# 访问地址: http://localhost:5173
```

### 默认账号

系统通过 Flyway 迁移脚本创建初始管理员账号，首次部署后请立即修改默认密码。

## 主要 API

| 模块 | 接口 | 说明 |
|------|------|------|
| 认证 | `POST /api/auth/login` | 登录获取 JWT |
| 知识库 | `GET /api/kb` | 知识库列表 |
| 知识库 | `POST /api/kb` | 创建知识库 |
| 文档 | `POST /api/kb/{id}/docs` | 创建文档 |
| 文档 | `POST /api/kb/docs/{docId}/publish` | 发布文档(触发分块+向量化) |
| 问答 | `POST /api/test/ask` | RAG 问答(SSE 流式) |
| 测试 | `PUT /api/test/records/{id}/score` | 对回答评分 |
| 用户 | `GET /api/system/users` | 用户列表 |
| 分类 | `GET /api/system/categories` | 分类列表 |

## 用户角色

| 角色 | 权限 |
|------|------|
| admin | 全部功能：知识库管理 + 问答测试 + 系统管理 |
| editor | 知识库编辑 + 问答测试 |
| viewer | 只读访问 |

## License

Private - 内部使用