86 lines
2.4 KiB
Markdown
86 lines
2.4 KiB
Markdown
# 模块需求文档索引
|
||
|
||
本文档用于汇总 Universal Agent Demo Framework V1 的模块拆分和需求文档位置。
|
||
|
||
## 1. 模块拆分原则
|
||
|
||
V1 按 6 个核心模块拆分：
|
||
|
||
```text
|
||
config
|
||
apps.scenarios
|
||
apps.documents
|
||
apps.chat
|
||
apps.audit
|
||
agent_core
|
||
```
|
||
|
||
拆分原则：
|
||
|
||
- Django Apps 负责业务外壳。
|
||
- Agent Core 负责 AI 能力。
|
||
- RAG、工具调用、模型适配不直接写进 View。
|
||
- 第一版不做复杂权限、多租户和完整工作流。
|
||
- 模块数量保持克制，方便复试前快速改题。
|
||
|
||
## 2. 模块文档列表
|
||
|
||
| 模块 | 文档 | 说明 |
|
||
|---|---|---|
|
||
| 配置 | `3.配置模块需求.md` | Django 项目配置、环境变量、部署配置 |
|
||
| 场景 | `4.场景模块需求.md` | 场景模板、场景配置、场景列表 |
|
||
| 文档 | `5.文档模块需求.md` | 文件上传、文件管理、RAG 入库入口 |
|
||
| 对话 | `6.对话模块需求.md` | 对话页面、Agent 调用、结果展示 |
|
||
| 审计 | `7.审计模块需求.md` | 审计日志、检索记录、工具调用记录 |
|
||
| 智能核心 | `8.智能核心模块需求.md` | RAG、工具、模型调用、结构化输出、编排 |
|
||
|
||
## 3. 模块依赖关系
|
||
|
||
```text
|
||
apps.chat
|
||
|-- depends on apps.scenarios
|
||
|-- depends on apps.audit
|
||
|-- calls agent_core
|
||
|
||
apps.documents
|
||
|-- depends on apps.scenarios
|
||
|-- calls agent_core.rag.ingest
|
||
|
||
apps.audit
|
||
|-- stores result from apps.chat / agent_core
|
||
|
||
agent_core
|
||
|-- reads scenario config object
|
||
|-- uses Chroma
|
||
|-- uses LLM Provider
|
||
|-- uses Tool Registry
|
||
```
|
||
|
||
## 4. 推荐开发顺序
|
||
|
||
建议按以下顺序开发：
|
||
|
||
1. Config 模块：保证项目可启动。
|
||
2. Scenarios 模块：展示 5 个预置场景。
|
||
3. 智能核心最小闭环：输入问题，通过 OpenAI 兼容模型接口返回结构化结果。
|
||
4. Chat 模块：页面调用 Agent Core。
|
||
5. Audit 模块：记录每次对话。
|
||
6. Documents 模块：上传文档。
|
||
7. Agent Core RAG：文档入库和检索。
|
||
8. Agent Core 工具系统：增加内置工具。
|
||
9. Docker：一键启动。
|
||
|
||
## 5. V1 完成标准
|
||
|
||
模块文档全部完成后，V1 的实现应满足：
|
||
|
||
- 系统可以启动。
|
||
- 首页可以看到 5 个场景。
|
||
- 可以进入场景对话。
|
||
- 可以上传文档。
|
||
- 可以触发 RAG 入库。
|
||
- Agent 可以返回结构化输出。
|
||
- 工具调用和引用来源可以展示。
|
||
- 每次对话都有审计日志。
|
||
- Docker Compose 可以一键启动。
|