67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
# Common Agent Studio 模块总览
|
||
|
||
## 1. 文档目的
|
||
|
||
本文用于统一本轮文档重构的模块口径。后续需求分析、设计文档、前端实现文档、后端实现文档和数据库设计均以本文的产品域模块为准，不再直接按旧后端包名划分。
|
||
|
||
本轮只处理文档和 SQL 脚本，不修改 Java、Vue、测试代码。
|
||
|
||
## 2. 模块划分
|
||
|
||
| 序号 | 模块 | 范围 |
|
||
|------|------|------|
|
||
| 1 | 系统基础 | 系统枚举、附件、审计字段、统一返回体、文档解析抽象 |
|
||
| 2 | 知识资产与文件解析 | 知识库、知识文档、解析快照、切片、向量、索引任务 |
|
||
| 3 | 模型与路由 | 模型服务商、模型配置、任务路由、知识库模型绑定、调用日志 |
|
||
| 4 | Workflow 编排 | 项目空间、Workflow 定义、版本快照、运行记录、步骤日志 |
|
||
| 5 | Agent 会话 | Agent 定义、调试运行、会话、消息、引用切片 |
|
||
| 6 | MCP 能力接入 | MCP Server 导入、能力发现、能力启停用 |
|
||
| 7 | Skill 编辑 | Skill 定义、版本、Prompt/Code/Config、测试结果 |
|
||
| 8 | 运行观测 | Workflow Trace、模型调用日志、成本、延迟、异常排查 |
|
||
|
||
## 3. 目录规范
|
||
|
||
| 目录 | 用途 |
|
||
|------|------|
|
||
| `需求分析/` | 描述业务目标、角色、场景、范围和验收标准 |
|
||
| `设计文档/` | 描述领域模型、状态流转、模块依赖和接口形态 |
|
||
| `数据库设计/` | 描述表结构、枚举、脚本同步规则和跨模块关系 |
|
||
| `前端实现文档/` | 描述页面、ViewModel、API 调用和交互状态 |
|
||
| `后端实现文档/` | 描述 Controller、DTO、Service、Entity、Mapper 和校验规则 |
|
||
|
||
## 4. 脚本范围
|
||
|
||
本轮 SQL 脚本属于正式交付范围：
|
||
|
||
- `script/sql/*.sql`：面向落库执行的模块化脚本。
|
||
- `docs/MODEL_PROVIDER_SCHEMA.sql`：模型平台 schema 汇总。
|
||
- `docs/STUDIO_PROTOTYPE_SCHEMA.sql`：Studio 原型 schema 汇总。
|
||
|
||
新增或调整数据库设计时，必须同步更新对应脚本。新增或调整枚举设计时，必须同步更新 `sys_enum` 初始化脚本。
|
||
|
||
## 5. 枚举约束
|
||
|
||
`sys_enum` 表结构保持不变，Java 枚举契约保持现有格式不变：
|
||
|
||
- `catalog`
|
||
- `type`
|
||
- `name`
|
||
- `value`
|
||
- `strvalue`
|
||
- `sort`
|
||
- `remark`
|
||
|
||
前后端结构化枚举继续使用整型 `value` 作为协议值，不改成字符串协议。
|
||
|
||
## 6. 交叉引用规则
|
||
|
||
每个模块文档必须说明：
|
||
|
||
- 关联数据库表。
|
||
- 关联枚举组。
|
||
- 关联 SQL 脚本。
|
||
- 关联前端页面或原型 View。
|
||
- 关联后端接口草案。
|
||
|
||
最终以 `数据库设计/9.模块一致性校验.md` 统一检查跨模块冲突。
|