b309a32a98
后端： 1. deliver 收口上下文重构——历史折叠到工作区，仅基于本轮 execute 窗口诚实收口 - newAgent/prompt/deliver.go：BuildDeliverMessages 改为向 buildDeliverWorkspace 透传 ConversationContext - newAgent/prompt/deliver_context.go：deliver 的 msg1 改为轻量提示，不再回灌完整历史；msg2 追加本轮 execute 窗口与结果态信息 前端： 2. 品牌命名统一切换为 SmartMate - index.html：页面标题从 SmartFlow 改为 SmartMate - package.json：前端包名改为 smartmate-frontend - App.vue：布局类名从 smartflow-* 统一改为 smartmate-* - stores/auth.ts：access/refresh token 与 last username 的 localStorage key 全部切到 smartmate_* - utils/idempotency.ts：默认幂等键前缀从 smartflow 改为 smartmate - DashboardView.vue：首页默认问候名从 SmartFlow 用户改为 SmartMate 用户 3. 助手页体验重做——默认空会话、排程卡片懒加载、上下文统计刷新时机收口 - components/dashboard/AssistantPanel.vue：进入页面不再自动打开最后一次会话，改为展示居中欢迎空态 - components/dashboard/AssistantPanel.vue：schedule_completed 改为先展示占位卡片，点击后再拉取 schedule preview，避免预览未落库时并发 404 - components/dashboard/AssistantPanel.vue：tool done、schedule card、SSE block done、[DONE] 与整轮流结束后统一刷新 context stats - components/dashboard/AssistantPanel.vue：重构聊天区布局、空态欢迎内容、底部交互区与内外边距，整体视觉切到更轻的阅读式界面 - views/AssistantView.vue：移除外层白底卡片壳，交由 AssistantPanel 自己承接容器视觉 4. 排程微调保存链路补幂等保护，并修正请求头口径 - api/schedule_agent.ts：正式应用接口请求头从 Idempotency-Key 改为 X-Idempotency-Key - components/assistant/ScheduleFineTuneModal.vue：同一预览会话复用稳定幂等键，保存成功后再刷新新 key，避免重试或延迟导致重复落库 - components/assistant/ScheduleResultCard.vue：结果卡片样式、hover 与进场动效整体升级 5. 任务类选择器与侧边导航细节调整 - components/assistant/TaskClassPlanningPicker.vue：popover、骨架屏、列表项、选中态与按钮视觉整体重绘 - components/common/MainSidebar.vue：移除“任务”占位入口，侧栏只保留总览 / 日程 / 助手 6. 登录页与首页展示风格重做 - views/AuthView.vue：品牌文案切到 SmartMate，登录/注册从 tabs 改为自定义双态切换，重做背景、玻璃卡片、表单与动效 - views/DashboardView.vue：首页主区改为 auto + 1fr 布局，锁定顶部栏高度，避免缩放时形变 仓库： 7. README 全量更新到当前版本能力边界 - README.md：重写项目定位、功能描述、业务闭环图、newAgent graph 流程、工具定义、前端衔接边界、页面展示、部署方案与监控说明
1026 lines
54 KiB
Markdown
1026 lines
54 KiB
Markdown
# 许可证
|
||
|
||
本项目采用 **GNU Affero General Public License v3.0 (AGPL-3.0)** 进行许可。
|
||
|
||
详见根目录 [`LICENSE`](./LICENSE) 文件。
|
||
|
||
# 时伴 SmartMate
|
||
|
||
> 越用越懂你的成长型 AI 排程伙伴 · 面向大学生的陪伴式日程管理平台
|
||
|
||
# 1 项目概览
|
||
|
||
## 1.1 总体介绍
|
||
|
||
时伴（SmartMate）是面向大学生的 AI 排程伙伴。通过自然语言对话管理课表与任务，更能在一次次交流中记住你的习惯、偏好和生活节奏——**越用越懂你，越排越贴心。**
|
||
|
||
核心能力包括：大规模智能排程、基于课表的任务编排、AI 驱动的"小事随口记"，以及跨会话的长期记忆积累——做到：**一个伙伴，包揽生活大小事。**
|
||
|
||
本项目采用前后端分离设计，并且有一个**完整的工业化设计链路**：写功能-墨刀画页面-根据页面写接口-写后端-写前端(AI)。
|
||
|
||
## 1.2 项目解决的痛点
|
||
|
||
> **问题1：** 传统的日程平台(类似于滴答清单等)要么设置重复任务(例如每日背单词、每日刷题等)，要么就需要手动设置任务，非常不方便。一旦遇到需要大规模安排任务的场景，例如期末考前半个月突击(涉及的科目多，手头的空余时间也多，每门课的任务又都不一样)，就需要先手动规划好任务，再手指点个不停给它排进日程软件里面，还得思考怎样排比较合理，一旦执行出问题需要调整，又像多米纳骨牌倒了一样，连着调整一大块。
|
||
|
||
**本项目带来的解决方案1：** 采用类似于老师备课-教务处排课的"备课-排课"模式。即假如你是学校上课的老师，你先在"备课区"把这门课程的"教学"大纲排好，然后再考虑后面安排上课的事情。
|
||
|
||
拿概率论举例子，你准备给它16节课时间复习，那你就在新增任务类的区域**创建新任务类**，并设置好在第x**任务块**看xx章节的速成课，然后第x任务块是真题练习。
|
||
|
||
设置完了之后，再通过我们的排课功能(会先设计一个保证能排的算法，第二批次开发还会考虑AI介入让课排的更好)，你设置一些排课的倾向(更倾向于在哪个时间点学、不想在哪个时间点学、想每天均匀推进还是快速突击等等)，点一下**智能一键编排**按钮，会将课直接以黄色打底的形式嵌入日程中，确认无误后你点击正式应用日程，课才会真正被排进去。
|
||
|
||
至于调整，本项目支持在课表区域直接拖拽调整时间。
|
||
|
||
> **问题2：** 期末周没课，确实可以按照上面一样操作。那我如果不是期末复习呢，我如果想安排一些别的事情呢，比如推进项目？我平时可是有课的，而且有不少水课。传统的日程软件可没法在水课处排课，要么忘记去上水课，要么忘记任务，十分恼火。
|
||
|
||
**本项目带来的解决方案2：** 本项目支持学校课表导入，甚至还支持水课嵌入任务。在导入课表之后，本项目支持勾选某些课程为"**可嵌入任务**"状态，此时就可以配合上面的排课系统，将水课作为可用的区域，排任务进去。
|
||
|
||
> **问题3：** 那么我作为一个规划能力比较差的懒人，也能用这个项目来让自己变的充实吗？
|
||
|
||
**本项目带来的解决方案3：** 当然可以，这就是本项目接入AI的意义。聊天区域的AI将会被调教成一个日程安排的小助手，既能满足你简单的任务记录、任务查询与部分日程调整需求，又能协助你从0开始一点点制定属于你的计划。(当前版本已支持AI随口记、任务查询，以及部分日程调整的确认流；更完整的自动规划与更复杂的读写能力仍在继续迭代)
|
||
|
||
> **问题4：** 我平时会突然冒出来一个能让自己活的更舒服亦或是变得更好的小想法(例如把桌面理一下、给自己挑一件新衣服等)，但是现在很忙，根本没时间做，然后等忙完了有时间了又忘记了。传统的日程软件确实能让我记录下来(比如将这个小想法记录在日程软件的四象限里面的"不重要不紧急"象限)，就是太麻烦了。
|
||
>
|
||
> 还有，平时上课时，接踵而至的实验报告、小组作业等，也面临着类似的情况，既容易忘记，又懒得记录。
|
||
|
||
**本项目带来的解决方案4：** 本项目支持AI驱动的"随口记"功能。
|
||
|
||
你可以和本项目的AI助手说："提醒我**有空的时候**给自己挑一件新衣服"(**请注意标粗的关键词**)，AI助手就会自动评估这件小事的难度以及执行所需花费的时间：如果这件事很简单或者不费时，会被加入"简单不重要"的队列中；如果比较费时或者困难，就会被加入"不简单不重要"队列中。
|
||
|
||
至于突发任务，也支持使用该"随口记"功能。你可以这么说："提醒我**下周周日之前**完成xx课程的大作业"(**请注意标粗的关键词**)，AI就会自动通过**截止时间和任务量**判断是否紧急，选择将其加入"重要并紧急"或者"重要不紧急"任务队列中(这里也是借鉴了四象限设计)。并且，系统会**每经过一个固定时间，就自动调整两个任务队列中未完成任务的位置**(比如：随着DDL临近，将重要不紧急队列中的未完成任务挪到重要并紧急队列中)。
|
||
|
||
当你在空闲时(做完你的大主线之后)，亦或是休息时间打开本项目，一眼就能看到这几个队列的事情，然后你就可以看心情选择做哪个，然后做完之后一划就完事。
|
||
|
||
> **问题5：** 每次打开 AI 助手，都要重新告诉它"我周三有课"、"我更喜欢早上学数学"。传统工具对你没有记忆，每次都从零开始，永远是个陌生人。
|
||
|
||
**本项目带来的解决方案5：** 时伴内置长期记忆系统，会在对话中自动抽取并积累关于你的事实与偏好（课程、习惯、目标等）。下次对话时自动召回相关记忆注入上下文，跨会话延续对你的了解，且支持全链路优雅降级——记忆检索失败不阻断正常对话。
|
||
|
||
## 1.3 项目实现的功能
|
||
|
||
1. **对用户目前时间尺度的适应。**
|
||
|
||
当前版本以学校排课节次为主，采用第1-2节、第3-4节这种时间组织方式，同时兼容首页任务管理与周课表日程编排两套视图，方便把任务管理和日程安排放在同一系统中；
|
||
|
||
目前暂未开放用户自定义时间尺度配置，当前仍以固定节次模型为主。后续会有更新计划的！
|
||
|
||
2. **导入学校课表。** 本项目后端已提供学校课表导入能力(当前主要尝试兼容CQUPT的课表格式)，以便后续以课表为基底进行日程安排；前端完整导入流程入口仍在补齐。
|
||
|
||
3. **"水课"任务嵌入。** 正如上方**问题2**所言，在已导入课表的前提下，支持设置某一门你想拿来干其它事情的课为"可嵌入任务"状态，此时这门课所占据的时间区域就是可以嵌入任务的了，但是仍然有区别于其它完全空白的时间区域，便于真正安排适合在嘈杂环境下做的事情。
|
||
|
||
4. **设置某一任务类，并配置其编排参数。** 正如上方**问题1**所言，用户可以先设置一个大的任务类(例如概率论复习、算法进阶计划等等)，再为这个任务类配置任务块内容、起止日期、总节数、编排策略等信息，方便后续的日程编排。
|
||
|
||
5. **一键编排任务。** 结合算法与用户配置，将任务基于导入的课表和任务类设置先生成预览结果；确认无误后，再正式应用到日程中。
|
||
|
||
6. **AI随口记与任务查询。** 正如问题4所言，当前版本支持通过AI随手记录一些大小事，也支持按象限、关键词、截止时间等维度查询任务；部分日程调整能力已接入确认流。
|
||
|
||
7. **多用户。** 本系统可支持多个用户同时使用，并且记录AI对话、编排任务的Token使用情况等，并进行限额。
|
||
|
||
8. **四象限任务与日程编排并行管理。** 首页的四象限任务用于日常待办管理；
|
||
|
||
而周课表中的课程与排入日程的任务类则用于日程编排，两类信息分别展示、相互配合。
|
||
|
||
9. **完成任务状态的恢复。** 当前首页四象限任务支持将"已完成"恢复为"未完成"状态。
|
||
|
||
用户只需要在队列中找到该任务，然后再次点击对应状态按钮即可完成恢复。
|
||
|
||
至于日程侧，当前主要支持删除、解除安排与预览后再正式应用，其它更完整的恢复能力仍在后续迭代中。
|
||
|
||
10. **长期记忆积累。** 系统在对话中自动抽取用户相关事实与偏好，跨会话召回并注入对话上下文，实现"越用越懂你"的个性化体验。支持结构化检索 + 向量召回双路召回，全链路优雅降级。
|
||
|
||
# 2 产品逻辑与设计
|
||
|
||
## 2.1 业务流程图
|
||
|
||
当前版本主业务闭环如下，重点体现“首页任务管理 / AI 助手 / 日程编排 / 长期记忆”四条主线如何互相联动：
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["用户进入系统"] --> B{"是否已登录"}
|
||
B -- "否" --> C["/auth 登录 / 注册"]
|
||
C --> D["进入主工作区"]
|
||
B -- "是" --> D
|
||
|
||
D --> E{"选择功能入口"}
|
||
|
||
E -- "首页 /dashboard" --> F["查看四象限任务 + 今日日程"]
|
||
F --> G["创建任务 / 完成任务 / 恢复任务"]
|
||
G --> H["首页持续展示最新待办状态"]
|
||
|
||
E -- "AI 助手 /assistant" --> I["输入自然语言需求"]
|
||
I --> J["newAgent 统一 graph"]
|
||
J --> K{"路由结果"}
|
||
K -- "随口记 / 任务查询" --> L["写入任务或返回查询结果"]
|
||
K -- "智能编排 / 日程调整" --> M["plan / confirm / execute / deliver"]
|
||
K -- "普通问答" --> N["直接回复用户"]
|
||
|
||
M --> O["返回排程结果卡片"]
|
||
O --> P["查看结构化预览并继续微调"]
|
||
P --> Q{"如何收口"}
|
||
Q -- "暂存" --> R["保存到 Redis 运行态"]
|
||
Q -- "正式应用" --> S["写入正式课表"]
|
||
|
||
L --> T["更新任务列表 / 对话历史"]
|
||
N --> U["沉淀对话历史"]
|
||
|
||
E -- "日程中心 /schedule" --> V["查看周课表与任务类"]
|
||
V --> W["新建任务类 / 删除任务块 / 单选或批量多选"]
|
||
W --> X["智能粗排 / 批量粗排"]
|
||
X --> Y["前端预览态拖拽调整"]
|
||
Y --> Z["正式应用到日程"]
|
||
|
||
S --> AA["周课表更新"]
|
||
Z --> AA
|
||
H --> AB["用户继续使用系统"]
|
||
T --> AB
|
||
U --> AB
|
||
AA --> AB
|
||
|
||
AB --> AC["异步事件：聊天持久化 / Outbox / Memory 抽取"]
|
||
AC --> AD["长期记忆写入与更新"]
|
||
AD --> AE["下一轮对话自动召回 memory_context"]
|
||
AE --> I
|
||
```
|
||
|
||
## 2.2 页面展示
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# 3 后端数据架构
|
||
|
||
## 3.1 ER图
|
||
|
||
PS：此图截至版本v0.3.3
|
||
|
||
|
||
|
||
## 3.2 核心表结构
|
||
|
||
其实每个表都很核心。在此展示它们的创建语句：
|
||
|
||
```sql
|
||
CREATE TABLE `agent_chats`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`user_id` int DEFAULT NULL,
|
||
`message_content` text COMMENT '用户或AI的话',
|
||
`role` varchar(255) DEFAULT NULL COMMENT 'user / assistant',
|
||
`tokens_consumed` int DEFAULT '0' COMMENT '单次消耗，用于累加到 users 表',
|
||
`created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uk_agent_chats_id` (`id`),
|
||
KEY `user_id` (`user_id`),
|
||
CONSTRAINT `agent_chats_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)
|
||
) ENGINE = InnoDB
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `courses`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`user_id` int DEFAULT NULL,
|
||
`name` varchar(255) NOT NULL,
|
||
`location` varchar(255) DEFAULT NULL,
|
||
`is_filler` tinyint(1) DEFAULT '0',
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uk_courses_id` (`id`),
|
||
KEY `user_id` (`user_id`),
|
||
CONSTRAINT `courses_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)
|
||
) ENGINE = InnoDB
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `schedule_events`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`user_id` int NOT NULL,
|
||
`name` varchar(255) NOT NULL COMMENT '课程或任务名称',
|
||
`location` varchar(255) DEFAULT '' COMMENT '地点 (教学楼/会议室)',
|
||
`type` enum ('course','task') NOT NULL COMMENT '日程类型',
|
||
`rel_id` int DEFAULT NULL COMMENT '关联原始数据ID (如教务系统的课程ID)',
|
||
`can_be_embedded` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否允许在此时段嵌入其他任务',
|
||
`created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
|
||
`updated_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
|
||
`start_time` datetime DEFAULT NULL COMMENT '任务开始的绝对时间',
|
||
`end_time` datetime DEFAULT NULL COMMENT '任务结束的绝对时间',
|
||
PRIMARY KEY (`id`),
|
||
KEY `idx_user_events` (`user_id`),
|
||
KEY `idx_user_endtime` (`user_id`, `end_time` DESC),
|
||
CONSTRAINT `fk_event_user` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE CASCADE
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 148
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `schedules`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`event_id` int NOT NULL COMMENT '关联元数据ID',
|
||
`user_id` int NOT NULL COMMENT '冗余UID方便直接查询',
|
||
`week` int NOT NULL COMMENT '周次 (1-25)',
|
||
`day_of_week` int NOT NULL COMMENT '星期 (1-7)',
|
||
`section` int NOT NULL COMMENT '原子化节次 (1-12)',
|
||
`embedded_task_id` int DEFAULT NULL COMMENT '若为水课嵌入，记录具体的任务项ID',
|
||
`status` enum ('normal','interrupted') DEFAULT 'normal' COMMENT '状态: 正常/因故中断',
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `idx_user_slot_atomic` (`user_id`, `week`, `day_of_week`, `section`),
|
||
KEY `idx_event_id` (`event_id`),
|
||
KEY `fk_embedded_task` (`embedded_task_id`),
|
||
CONSTRAINT `fk_embedded_task` FOREIGN KEY (`embedded_task_id`) REFERENCES `task_items` (`id`) ON DELETE SET NULL,
|
||
CONSTRAINT `fk_schedule_event` FOREIGN KEY (`event_id`) REFERENCES `schedule_events` (`id`) ON DELETE CASCADE,
|
||
CONSTRAINT `fk_schedule_user` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE CASCADE
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 214
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `task_classes`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`user_id` int DEFAULT NULL,
|
||
`name` varchar(255) DEFAULT NULL,
|
||
`mode` enum ('auto','manual') DEFAULT NULL,
|
||
`start_date` date DEFAULT NULL,
|
||
`end_date` date DEFAULT NULL,
|
||
`total_slots` int DEFAULT NULL COMMENT '分配的总节数',
|
||
`allow_filler_course` tinyint(1) DEFAULT '1',
|
||
`strategy` enum ('steady','rapid') DEFAULT NULL,
|
||
`excluded_slots` json DEFAULT NULL COMMENT '不想要的时段切片',
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uk_task_classes_id` (`id`),
|
||
KEY `idx_task_classes_user_id` (`user_id`),
|
||
CONSTRAINT `task_classes_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 15
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `task_items`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`category_id` int DEFAULT NULL,
|
||
`content` text,
|
||
`embedded_time` json DEFAULT NULL COMMENT '目标时间{date,section_from,section_to}',
|
||
`status` int DEFAULT NULL COMMENT '1:未安排, 2:已应用',
|
||
`order` int DEFAULT NULL,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uk_task_items_id` (`id`),
|
||
KEY `task_items_ibfk_1` (`category_id`),
|
||
CONSTRAINT `task_items_ibfk_1` FOREIGN KEY (`category_id`) REFERENCES `task_classes` (`id`) ON DELETE CASCADE
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 43
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `tasks`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`user_id` int DEFAULT NULL,
|
||
`title` varchar(255) NOT NULL,
|
||
`priority` int DEFAULT NULL,
|
||
`is_completed` tinyint(1) DEFAULT '0',
|
||
`deadline_at` timestamp NULL DEFAULT NULL,
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `uk_tasks_id` (`id`),
|
||
KEY `idx_user_id` (`user_id`),
|
||
CONSTRAINT `tasks_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`),
|
||
CONSTRAINT `chk_priority` CHECK ((`priority` in (1, 2, 3, 4)))
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 23
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
|
||
CREATE TABLE `users`
|
||
(
|
||
`id` int NOT NULL AUTO_INCREMENT,
|
||
`username` varchar(255) NOT NULL,
|
||
`password` varchar(255) NOT NULL,
|
||
`phone_number` varchar(255) DEFAULT NULL,
|
||
`token_limit` int DEFAULT '100000',
|
||
`token_usage` int DEFAULT '0',
|
||
`last_reset_at` timestamp NULL DEFAULT NULL COMMENT '上次周用量重置时间',
|
||
PRIMARY KEY (`id`),
|
||
UNIQUE KEY `username` (`username`),
|
||
UNIQUE KEY `uk_users_id` (`id`)
|
||
) ENGINE = InnoDB
|
||
AUTO_INCREMENT = 4
|
||
DEFAULT CHARSET = utf8mb4
|
||
COLLATE = utf8mb4_0900_ai_ci
|
||
```
|
||
|
||
# 4 接口契约
|
||
|
||
## 4.1 核心API列表(ApiFox)
|
||
|
||
链接如下：https://oqg5uiubh0.apifox.cn
|
||
|
||
## 4.2 Agent可调用的工具定义
|
||
|
||
以下定义基于当前代码实现（`backend/newAgent/tools/registry.go` + `backend/cmd/start.go` 注入），不是规划态文档。
|
||
|
||
### 4.2.1 调用契约
|
||
|
||
1. `tool_call` 必须是单个对象，格式为：
|
||
|
||
```json
|
||
{"tool_call":{"name":"工具名","arguments":{}}}
|
||
```
|
||
|
||
2. 日程写工具默认走 `confirm` 确认闸门（`always_execute=true` 时可跳过确认）。
|
||
3. 非日程写工具（如 `quick_note_create`、`query_tasks`、`web_search`、`web_fetch`）走 `continue + tool_call`。
|
||
4. 当前每轮只允许调用一个工具，不支持同轮批量工具数组。
|
||
|
||
### 4.2.2 工具清单（当前版本）
|
||
|
||
| 工具名 | 类型 | 是否需确认 | 是否依赖 ScheduleState | 核心参数 | 作用与约束 |
|
||
| --- | --- | --- | --- | --- | --- |
|
||
| `get_overview` | 读 | 否 | 是 | 无 | 获取规划窗口总览（任务视角，全量返回） |
|
||
| `query_range` | 读 | 否 | 是 | `day`(必填), `slot_start`, `slot_end` | 查询某天/某时段占用详情 |
|
||
| `query_available_slots` | 读 | 否 | 是 | `span`, `duration`, `limit`, `day_scope`, `week_filter` 等 | 查询候选空位池（纯空位优先，不足再补可嵌入位） |
|
||
| `query_target_tasks` | 读 | 否 | 是 | `status`, `category`, `task_ids`, `enqueue` 等 | 过滤任务集合，可选自动入队供后续队列工具处理 |
|
||
| `queue_pop_head` | 读 | 否 | 是 | 无 | 取出/复用当前队首任务（一次只处理一个） |
|
||
| `queue_status` | 读 | 否 | 是 | 无 | 查看队列状态（pending/current/completed/skipped） |
|
||
| `get_task_info` | 读 | 否 | 是 | `task_id`(必填) | 查询单任务详细信息 |
|
||
| `place` | 写 | 是 | 是 | `task_id`, `day`, `slot_start`(均必填) | 将待安排任务预排到指定位置 |
|
||
| `move` | 写 | 是 | 是 | `task_id`, `new_day`, `new_slot_start`(均必填) | 仅允许移动 `suggested`；`existing` 不可 `move` |
|
||
| `swap` | 写 | 是 | 是 | `task_a`, `task_b`(均必填) | 交换两个已落位任务，要求时长一致 |
|
||
| `batch_move` | 写 | 是 | 是 | `moves[]`(必填) | 原子批量移动，当前最多 2 条，任一冲突整批回滚 |
|
||
| `queue_apply_head_move` | 写 | 是 | 是 | `new_day`, `new_slot_start`(均必填) | 移动当前队首并自动出队，不接受 `task_id` |
|
||
| `queue_skip_head` | 队列控制 | 否 | 是 | `reason` | 跳过当前队首并标记 `skipped`（不改日程） |
|
||
| `spread_even` | 写 | 是 | 是 | `task_ids`(必填，兼容 `task_id`) | 在任务集合内做均匀铺开，按筛选条件原子落地 |
|
||
| `min_context_switch` | 写 | 是 | 是 | `task_ids`(必填，兼容 `task_id`) | 减少上下文切换重排；仅在用户明确允许打乱顺序时可执行 |
|
||
| `unplace` | 写 | 是 | 是 | `task_id`(必填) | 取消任务落位并恢复待安排状态 |
|
||
| `quick_note_create` | 读写混合（业务写入） | 否 | 否 | `title`(必填), `deadline_at`, `priority_group` | 记录随口记任务，支持中文相对时间；优先级可自动推断 |
|
||
| `query_tasks` | 读 | 否 | 否 | `quadrant`, `keyword`, `deadline_before/after`, `limit` 等 | 按象限/关键词/时间边界查询任务 |
|
||
| `web_search` | 读 | 否 | 否 | `query`(必填), `top_k`, `domain_allow`, `recency_days` | Web 检索，返回结构化标题/摘要/URL；未启用时优雅返回错误 observation |
|
||
| `web_fetch` | 读 | 否 | 否 | `url`(必填), `max_chars` | 抓取并清洗网页正文；服务不可用时优雅返回错误 observation |
|
||
|
||
### 4.2.3 当前实现中的关键规则
|
||
|
||
1. `min_context_switch` 有顺序护栏：未授权“允许打乱顺序”会被后端拦截并返回拒绝结果。
|
||
2. `batch_move` 有安全上限：当前最多支持 2 条移动请求，超出建议走队列化逐项处理。
|
||
3. `quick_note_create` 和 `query_tasks` 不依赖 `ScheduleState`，由执行层注入 `_user_id` 后可直接调用。
|
||
4. `web_search`/`web_fetch` 失败不会打断主链路，都会回传结构化错误 observation 给模型继续决策。
|
||
|
||
|
||
# 5 后端实现
|
||
|
||
## 5.1 技术栈
|
||
|
||
| **分类** | **选用技术** | **在时伴中的应用场景** |
|
||
| ----------------- | ---------------- | ------------------------------------------------------------ |
|
||
| **Web 框架** | **Gin** | 负责全站 API 的路由分发，处理任务增删改查及智能排程的请求。 |
|
||
| **持久层数据库** | **MySQL 8.0** | 存储用户、任务、课表及日程运行图（Schedules）的核心数据。 |
|
||
| **ORM 框架** | **GORM** | 用于简化 Go 与数据库的交互，利用事务处理 `Apply` 接口的原子性操作。 |
|
||
| **高性能缓存** | **Redis** | 缓存用户的周日程视图（避免频繁扫表）、存储 Token 临时限额、实现分布式锁防止重复排程。 |
|
||
| **消息队列** | **Outbox + Kafka** | **可靠异步解耦**：请求主链路先写 Outbox，后台再投递 Kafka 并消费落库，既降低首字延迟又避免消息瞬时丢失。 |
|
||
| **AI 编排框架** | **Eino** | 作为 AI Agent 的大脑，根据排程策略（Steady/Rapid）计算任务与水课的嵌入逻辑。 |
|
||
| **身份认证** | **JWT** | 实现无状态登录，将 `user_id` 封装在 Token 中，确保数据的用户隔离。 |
|
||
| **配置管理** | **Viper** | 管理数据库、Redis、Kafka 的连接参数，支持多环境（开发/生产）切换。 |
|
||
| **API 文档/调试** | **Apifox** | 维护接口协议，进行前后端联调及自动化测试。 |
|
||
| **日志监控** | **Zap / Logrus** | 记录系统运行状态，特别是 Kafka 消费失败或 AI 接口超时的错误日志。 |
|
||
|
||
## 5.2 架构图
|
||
|
||
PS：截至v0.3.3。其中黑色箭头为请求数据链路，绿色箭头为返回数据，虚线箭头为控制流。
|
||
|
||
|
||
|
||
## 5.3 核心算法
|
||
|
||
### 5.3.1 智能排课算法
|
||
|
||
本系统采用 **“原子化时间网格（Atomic TimeGrid）”** 架构，实现了针对大学生复杂课表环境的智能任务填充。算法核心分为 **“沙盘模拟”、“边界感知探测”** 与 **“逻辑位移步进”** 三大模块。
|
||
|
||
**1. 原子化时间沙盘 (Grid Sandboxing)**
|
||
|
||
算法首先将物理时间窗口（StartDate 到 EndDate）抽象为一个三维矩阵 $Grid[Week][Day][Section]$。
|
||
|
||
- **多维状态标记**：每个格子（Slot）是携带 `Status` 和 `EventID` 的 `slotNode` 节点。
|
||
- **优先级注水（Hydration）**：
|
||
1. **Blocked（屏蔽区）**：根据用户配置的 `ExcludedSlots` 强制锁定，优先级最高。
|
||
2. **Filler（嵌入区）**：识别“水课”，标记为可利用资源。
|
||
3. **Occupied（占用区）**：映射既有硬核课程，确保调度不产生物理冲突。
|
||
|
||
**2. 边界感知探测 (Boundary-Sensing Detection)**
|
||
|
||
为了解决“任务块跨课分身”的 Bug，算法引入了 **EventID 校验机制**。
|
||
|
||
- **容器自适应长度**：当算法探测到一个 `Filler` 槽位时，会向后贪心扫描，只有当相邻槽位的 `EventID` 相同且同为 `Filler` 时，才允许任务块拉伸。
|
||
- **逻辑闭环**：这保证了任务块（TaskItem）要么完美嵌入单门水课，要么占据空地，绝不会出现一个任务横跨两门不同课程的情况。
|
||
|
||
**3. 稳扎稳打：逻辑位移步进 (Logical-Offset Skipping)**
|
||
|
||
在 `Steady`（稳扎稳打）模式下，为了实现负载均衡，算法弃用了传统的“物理时间跳跃”，改用 **“逻辑坑位跳跃”**。
|
||
|
||
$$Gap = \frac{TotalAvailableSlots - (TaskCount \times 2)}{TaskCount + 1}$$
|
||
|
||
- **物理跳跃（旧版/错误）**：直接 $Time + Gap$，容易因遇到屏蔽时段或硬核课而导致游标溢出，从而“吞掉”后续任务。
|
||
- **逻辑跳跃（现行/优化）**：调用 `skipAvailableSlots` 函数，在 Grid 中沿时间轴向后数出 $Gap$ 个**真正可用**的格子作为下一个起点。
|
||
- **价值**：确保了在有限的 **2C4G** 服务器资源下，任务能像“等距列队”一样均匀分布在学期空隙中。
|
||
|
||
------
|
||
|
||
**🛠️ 算法运行流程**
|
||
|
||
1. **Build**：调用 `buildTimeGrid`，将数据库的离散 `Schedules` 映射为内存状态网格。
|
||
2. **Count**：统计当前窗口内所有 `Free` 与 `Filler` 的原子位总数。
|
||
3. **Allocate**：
|
||
- 通过 `FindNextAvailable` 锁定首个合法坑位。
|
||
- 进行 **容器探测** 决定任务块长度。
|
||
- 执行 `skipAvailableSlots` 寻找下一个负载均衡点。
|
||
4. **Preview**：输出 DTO 到前端，标记 `status: "suggested"` 供用户预览高亮。
|
||
|
||
------
|
||
|
||
**⚡ 性能表现 (Optimization)**
|
||
|
||
- **时间复杂度**：$O(W \times D \times S)$，其中 $W$ 为任务类跨度周数。在处理典型的 16 周排程时，计算量仅在数千次操作级别，单机响应达毫秒级。
|
||
- **空间复杂度**：由于采用了按需创建周 Map 的策略，内存占用随任务跨度动态伸缩，极大地减轻了重庆邮电大学校园服务器环境下的 GC 压力。
|
||
|
||
------
|
||
|
||
**数据回填**
|
||
|
||
在执行完上述算法后，将任务块分成两类数据：
|
||
|
||
1. 需要新建`ScheduleEvent`的，插入纯空闲时段的数据；
|
||
2. 直接嵌入现有课程中的任务块；
|
||
|
||
然后分别调用不同的业务逻辑，开启大事务，批量插入，使得只需要连接2次数据库，并且若插入出错，支持批量回滚，不会存在任何脏数据。
|
||
|
||
## 5.4 Agent范式实现细节
|
||
|
||
### 1) 统一入口与 graph 主链
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["/api/v1/agent/chat<br/>接收 user_message / thinkingMode / extra"] --> B["AgentService.runNewAgentGraph"]
|
||
B --> C["确保会话存在<br/>加载或创建 RuntimeState"]
|
||
C --> D["恢复或构建 ConversationContext<br/>并预取 memory pinned block"]
|
||
D --> E["先持久化本轮 user message"]
|
||
E --> F["组装 AgentGraphRunInput<br/>Chat/Deliver 用 Pro<br/>Plan/Execute 用 Max"]
|
||
F --> G["RunAgentGraph"]
|
||
G --> H["START -> chat"]
|
||
|
||
H --> I{"chat 决定下一步"}
|
||
I -- "简单回复 / 深答" --> J["chat 节点内直接完成"]
|
||
I -- "复杂规划" --> K["plan"]
|
||
I -- "直接执行" --> L["execute"]
|
||
I -- "execute 前需要粗排" --> M["rough_build"]
|
||
I -- "已有 pending interaction" --> N["chat 先做 resume"]
|
||
|
||
K --> O["confirm / rough_build / execute / deliver / interrupt"]
|
||
L --> P["execute / confirm / order_guard / deliver / interrupt"]
|
||
M --> Q["execute / order_guard / deliver / interrupt"]
|
||
N --> O
|
||
N --> P
|
||
|
||
J --> R["deliver 或 END"]
|
||
O --> S["deliver"]
|
||
P --> S
|
||
Q --> S
|
||
S --> T["END"]
|
||
```
|
||
|
||
### 2) `chat` 节点路由与恢复
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["进入 chat 节点"] --> B{"存在 pending interaction?"}
|
||
|
||
B -- "是" --> C["handleChatResume<br/>不再调路由 LLM"]
|
||
C --> D{"pending 类型"}
|
||
D -- "ask_user" --> E["ResumeFromPending<br/>发 resumed 状态"]
|
||
E --> F["恢复原 phase<br/>继续 plan 或 execute"]
|
||
D -- "confirm + accept" --> G["恢复 PendingTool<br/>Phase=executing"]
|
||
D -- "confirm + reject(计划)" --> H["RejectPlan<br/>回 planning"]
|
||
D -- "confirm + reject(工具)" --> I["回 executing 改策略"]
|
||
D -- "interaction_id 不匹配" --> J["stale_resume<br/>本轮结束"]
|
||
|
||
B -- "否" --> K{"上一轮是否 completed?"}
|
||
K -- "是" --> L["写 execute_loop_closed marker<br/>ResetForNextRun"]
|
||
K -- "否" --> M["直接构建路由消息"]
|
||
L --> M
|
||
M --> N["一次快速路由 LLM<br/>BuildChatRoutingMessages"]
|
||
N --> O{"route"}
|
||
|
||
O -- "direct_reply" --> P["chat 内直接流式回复<br/>Phase=chatting -> END"]
|
||
O -- "deep_answer" --> Q["二次 deep answer 调用<br/>可开启 thinking -> END"]
|
||
O -- "plan" --> R["Phase=planning"]
|
||
O -- "execute" --> S["StartDirectExecute<br/>写 AllowReorder / ExecuteThinking"]
|
||
|
||
S --> T{"NeedsRoughBuild?"}
|
||
T -- "是" --> U["rough_build"]
|
||
T -- "否" --> V["execute"]
|
||
R --> W["plan"]
|
||
```
|
||
|
||
### 3) `plan / confirm / rough_build` 链路
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["Phase=planning -> plan 节点"] --> B["LLM 生成 PlanDecision<br/>可开启 thinking"]
|
||
B --> C{"action"}
|
||
|
||
C -- "continue" --> A
|
||
C -- "ask_user" --> D["OpenAskUserInteraction<br/>graph -> interrupt"]
|
||
C -- "done" --> E["FinishPlan<br/>写 pinned blocks:<br/>current_plan / current_step"]
|
||
|
||
E --> F{"AlwaysExecute?"}
|
||
F -- "否" --> G["confirm"]
|
||
G --> H["EmitConfirmRequest<br/>OpenConfirmInteraction(type=plan)"]
|
||
H --> I["interrupt 等用户"]
|
||
I --> J["用户下一轮回复 -> chat resume"]
|
||
J --> K{"accept / reject"}
|
||
K -- "accept" --> L{"NeedsRoughBuild?"}
|
||
K -- "reject" --> A
|
||
|
||
F -- "是" --> M["自动展示计划摘要<br/>ConfirmPlan -> PhaseExecuting"]
|
||
M --> L
|
||
|
||
L -- "否" --> N["execute"]
|
||
L -- "是" --> O["rough_build"]
|
||
O --> P["调用 RoughBuildFunc<br/>写回 ScheduleState"]
|
||
P --> Q["写 rough_build_done pinned block<br/>标记 HasScheduleChanges"]
|
||
Q --> R{"仍有真实 pending?"}
|
||
R -- "是" --> S["Abort -> deliver"]
|
||
R -- "否" --> T{"需要继续微调?"}
|
||
T -- "是" --> N
|
||
T -- "否" --> U["Done -> deliver"]
|
||
```
|
||
|
||
### 4) `execute / confirm / order_guard` 链路
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["Phase=executing -> execute 节点"] --> U{"NextRound 成功?"}
|
||
U -- "否" --> V["Exhaust -> deliver"]
|
||
U -- "是" --> B{"有 PendingConfirmTool?"}
|
||
B -- "是" --> C["直接执行已确认写工具"]
|
||
B -- "否" --> D["BuildExecuteMessages<br/>LLM 产出 ExecuteDecision"]
|
||
|
||
C --> E["写 observation / 更新 ScheduleState"]
|
||
D --> F{"action"}
|
||
|
||
F -- "continue + tool_call" --> G["每轮只调用 1 个工具"]
|
||
G --> H{"写工具且需要确认?"}
|
||
H -- "是" --> I["PendingConfirmTool -> confirm"]
|
||
I --> J["EmitConfirmRequest<br/>OpenConfirmInteraction(type=execute)"]
|
||
J --> K["interrupt 等用户"]
|
||
K --> L["用户 accept -> chat resume -> execute"]
|
||
H -- "否" --> M["写 observation<br/>继续 execute 循环"]
|
||
|
||
F -- "continue 无工具" --> M
|
||
F -- "ask_user" --> N["OpenAskUserInteraction<br/>interrupt 等用户"]
|
||
F -- "next_plan" --> O["推进 current_step<br/>写 execute_step_advanced marker"]
|
||
O --> P{"还有后续计划?"}
|
||
P -- "是" --> M
|
||
P -- "否" --> Q["Done -> deliver"]
|
||
|
||
F -- "done" --> R{"AllowReorder?"}
|
||
R -- "false" --> S["order_guard<br/>校验 suggested 相对顺序"]
|
||
S --> T["自动复原或保守放行"]
|
||
T --> Q
|
||
R -- "true" --> Q
|
||
|
||
F -- "abort" --> Q
|
||
```
|
||
|
||
### 5) `interrupt / deliver / 状态持久化` 链路
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
A["plan / execute / confirm 产生 pending"] --> B["interrupt"]
|
||
B --> C{"pending 类型"}
|
||
C -- "ask_user" --> D["把 DisplayText 当 assistant 文本输出"]
|
||
C -- "confirm" --> E["不重复发确认卡片<br/>仅发 waiting status"]
|
||
D --> F["interrupt -> END"]
|
||
E --> F
|
||
F --> G["saveAgentState"]
|
||
G --> H["用户下一轮输入<br/>重新从 chat resume"]
|
||
|
||
I["任务正常完成 / abort / exhausted"] --> J["deliver"]
|
||
J --> K["GenerateDeliverSummary<br/>LLM 失败则降级机械总结"]
|
||
K --> L{"completed 且有日程变更?"}
|
||
L -- "是" --> M["EmitScheduleCompleted"]
|
||
L -- "否" --> N["跳过排程完毕卡片"]
|
||
M --> O["输出最终总结"]
|
||
N --> O
|
||
|
||
O --> P{"terminal_status=completed?"}
|
||
P -- "是" --> Q["WriteSchedulePreview<br/>只写结果态工作区"]
|
||
P -- "否" --> R["跳过排程预览写入"]
|
||
Q --> S["deliver 后 saveAgentState"]
|
||
R --> S
|
||
S --> T["graph 返回 service<br/>发布 AgentStateSnapshot(outbox)"]
|
||
T --> U["EmitDone + 异步生成会话标题"]
|
||
```
|
||
|
||
## 5.5 长期记忆系统
|
||
|
||
时伴的长期记忆系统采用**同步读 + 异步写**架构，确保对话体验不被记忆写入拖慢。
|
||
|
||
### 写路径（异步）
|
||
|
||
```
|
||
用户消息 → 聊天落库(同事务写 Outbox) → Kafka 投递 memory.extract.requested 事件
|
||
→ 幂等入队 memory_jobs → Worker 抢占执行 → LLM 抽取事实
|
||
→ 去重决策(ADD/UPDATE/DELETE/NONE) + UUID 映射防幻觉 → 持久化 memory_items
|
||
```
|
||
|
||
关键设计：
|
||
|
||
1. **Outbox 保证不丢消息**：聊天持久化与事件投递在同一事务内，失败整体回滚，由 Outbox 重试。
|
||
2. **去重决策状态机**：LLM 对抽取的事实判断是新增、更新、删除还是跳过，避免重复记忆。
|
||
3. **UUID 映射**：为每条记忆分配唯一 ID，LLM 引用时必须使用该 ID，防止幻觉篡改。
|
||
|
||
### 读路径（同步）
|
||
|
||
```
|
||
用户消息到达 → injectMemoryContext
|
||
→ 先读 Redis 预取缓存并注入 memory_context（上一轮检索结果，首字节零等待）
|
||
→ 后台完整检索：结构化检索(按用户/类别过滤) + 向量召回(Milvus) + 重排序
|
||
→ 渲染后的最新结果经 channel 交给 Plan/Execute 节点消费，同时回写 Redis
|
||
→ 作为下一轮 Chat 节点的预取记忆继续接力 → LLM 生成回复
|
||
```
|
||
|
||
关键设计：
|
||
|
||
1. **Redis 接力预取**：本轮 Chat 先消费上一轮写入 Redis 的记忆预取缓存，保证首字节几乎不受完整检索耗时影响；后台再把最新检索结果通过 channel 交给 Plan/Execute，并顺手回写 Redis，形成“上一轮服务下一轮”的接力链路。
|
||
2. **双路召回**：完整检索阶段仍采用结构化检索 + 向量召回的混合模式，先保证精确过滤，再补足语义相关性，最后统一重排序取 Top-K。
|
||
3. **优雅降级**：Redis 未命中、后台检索失败、短应答跳过检索等情况都不会阻断主链路；最差也只是本轮不注入记忆，而不是把对话打挂。
|
||
|
||
# 6 前端实现
|
||
|
||
当前前端位于 `frontend/` 目录，已经形成一个可独立运行的 Vue 单页应用，并且前端入口目前呈现为“两条主线并存”：
|
||
|
||
1. `/assistant`：承接 `newAgent` 对话、确认、时间线、排程结果卡片与微调链路。
|
||
2. `/schedule`：承接传统课表中心、任务类侧栏、粗排预览、拖拽调整与正式应用。
|
||
|
||
## 6.1 当前前端技术栈与整体结构
|
||
|
||
技术栈如下：
|
||
|
||
| 分类 | 当前选型 | 说明 |
|
||
| --- | --- | --- |
|
||
| 前端框架 | Vue 3 | 统一使用 Composition API 与 `<script setup>` |
|
||
| 构建工具 | Vite 6 | 本地开发、代理联调、生产构建统一由 Vite 提供 |
|
||
| 语言 | TypeScript | API、页面状态、排程数据结构已基本类型化 |
|
||
| UI 组件库 | Element Plus | 登录、表单、选择器、弹窗、消息提示等基础交互由其承接 |
|
||
| 状态管理 | Pinia | 当前主要用于认证态、token 与用户信息持久化 |
|
||
| 路由 | Vue Router 4 | 已配置 `requiresAuth` / `guestOnly` 守卫 |
|
||
| HTTP | Axios + 原生 `fetch` | 常规 JSON 接口走 Axios；`/agent/chat` 流式接口走原生 `fetch` |
|
||
| Markdown 渲染 | markdown-it + highlight.js | 助手正文支持 Markdown 渲染与代码高亮 |
|
||
|
||
当前前端工程结构如下：
|
||
|
||
```text
|
||
frontend/src
|
||
├─ api/ # auth / task / schedule / scheduleCenter / agent / schedule_agent
|
||
├─ components/
|
||
│ ├─ assistant/ # 上下文窗口、排程结果卡片、微调弹窗、任务类选择器
|
||
│ ├─ common/ # 全局主侧边栏 MainSidebar
|
||
│ ├─ dashboard/ # 首页卡片与 AssistantPanel
|
||
│ └─ schedule/ # 任务类侧栏、周课表画板、创建弹窗
|
||
├─ router/ # 路由定义与守卫
|
||
├─ stores/ # Pinia store（当前主要是 auth）
|
||
├─ types/ # dashboard / schedule / api 类型定义
|
||
├─ utils/ # 日期、Markdown、HTTP 错误、幂等 key 等工具
|
||
├─ views/ # Auth / Dashboard / Assistant / Schedule / Prototype
|
||
├─ App.vue # 全局布局壳层与 router-view 容器
|
||
└─ main.ts # Vue / Pinia / Router / Element Plus 挂载入口
|
||
```
|
||
|
||
工程约定如下：
|
||
|
||
1. 所有业务请求默认走 `/api/v1` 前缀。
|
||
2. 本地开发通过 Vite 代理把 `/api` 转发到 `http://127.0.0.1:8080`。
|
||
3. 常规接口统一走 `frontend/src/api/http.ts`，内置 `401 -> refresh token -> 原请求重放`。
|
||
4. 对话流接口 `POST /api/v1/agent/chat` 单独走原生 `fetch`，并在前端手动处理一次 refresh token 重试。
|
||
5. 写操作尽量补 `X-Idempotency-Key`，当前任务类创建、日程应用、日程删除、任务块删除都已接入。
|
||
6. `App.vue` 会对 `/dashboard`、`/assistant`、`/schedule` 统一套用主壳层与 `MainSidebar`，而不是每个页面各自维护一套侧边栏。
|
||
|
||
## 6.2 当前页面与路由状态
|
||
|
||
当前已接通的页面路由如下：
|
||
|
||
| 路由 | 页面状态 | 说明 |
|
||
| --- | --- | --- |
|
||
| `/` | 已完成 | 默认重定向到 `/dashboard` |
|
||
| `/auth` | 已完成 | 登录/注册同页切换，支持 `redirect` 回跳 |
|
||
| `/dashboard` | 已完成 | 首页工作台，承接四象限任务与今日日程 |
|
||
| `/assistant` | 已完成 | `newAgent` 对话主入口，支持时间线、确认卡片、排程结果卡片 |
|
||
| `/schedule` | 已完成 | 传统课表中心，支持任务类、粗排、拖拽预览与正式应用 |
|
||
| `/prototype/tool-trace` | 原型页 | 用于展示工具 trace / 阻断 / 排程卡片交互原型，不在主导航中暴露 |
|
||
|
||
当前仍未接出正式独立路由的入口：
|
||
|
||
1. “任务”独立页仍未落地，侧边栏没有 `/task` 路由。
|
||
2. 侧边栏底部“设置”按钮仍是视觉占位，尚未接出 `/settings`。
|
||
3. `src/views/layout`、`src/views/login`、`src/views/register`、`src/views/settings` 以及 `src/store/` 目前更偏预留/历史残留目录，不承载当前主运行链路。
|
||
|
||
## 6.3 认证页 `/auth`
|
||
|
||
对应文件：
|
||
|
||
- `frontend/src/views/AuthView.vue`
|
||
- `frontend/src/stores/auth.ts`
|
||
- `frontend/src/api/auth.ts`
|
||
|
||
当前行为：
|
||
|
||
1. 登录与注册共用一页，通过 tab 切换。
|
||
2. 登录成功后会把 `access_token`、`refresh_token` 与最近一次用户名写入 `localStorage`。
|
||
3. 路由守卫会阻止未登录用户进入 `/dashboard`、`/assistant`、`/schedule`。
|
||
4. 普通 JSON 接口走 Axios 自动续签；流式对话接口走 `fetch` 时也会在前端手动尝试一次 refresh token 重试。
|
||
5. 登出时会先尽力调用后端注销接口，再无条件清理本地登录态，避免前端出现“假在线”。
|
||
|
||
## 6.4 统一壳层与首页工作台 `/dashboard`
|
||
|
||
对应文件：
|
||
|
||
- `frontend/src/App.vue`
|
||
- `frontend/src/components/common/MainSidebar.vue`
|
||
- `frontend/src/views/DashboardView.vue`
|
||
- `frontend/src/components/dashboard/TaskQuadrantCard.vue`
|
||
- `frontend/src/components/dashboard/TodayTimeline.vue`
|
||
|
||
当前已实现能力：
|
||
|
||
1. `/dashboard`、`/assistant`、`/schedule` 已统一挂在同一套全局壳层下，由 `App.vue + MainSidebar` 负责外层布局。
|
||
2. 侧边栏当前只保留“总览 / 日程 / 助手”三项主导航，避免过早把尚未做完的页面入口暴露出来。
|
||
3. 首页中心区展示四象限任务卡片，支持获取任务列表、创建任务、完成任务、撤销完成任务。
|
||
4. 右侧展示“今日日程”，通过 `GET /api/v1/schedule/today` 拉取当天事件。
|
||
5. 首页顶部已具备退出登录、用户昵称展示、当前日期展示等基础工作台能力。
|
||
6. 首页整体做了缩放适配，目标是在常见笔记本分辨率下尽量完整展示主要内容，而不是依赖用户手动缩放浏览器。
|
||
7. “课表导入”入口目前仍是占位提示，还没有真正接出导入向导页。
|
||
|
||
## 6.5 AI 对话页 `/assistant`
|
||
|
||
对应文件：
|
||
|
||
- `frontend/src/views/AssistantView.vue`
|
||
- `frontend/src/components/dashboard/AssistantPanel.vue`
|
||
- `frontend/src/components/assistant/ContextWindowMeter.vue`
|
||
- `frontend/src/components/assistant/TaskClassPlanningPicker.vue`
|
||
- `frontend/src/components/assistant/ScheduleResultCard.vue`
|
||
- `frontend/src/components/assistant/ScheduleFineTuneModal.vue`
|
||
- `frontend/src/api/agent.ts`
|
||
- `frontend/src/api/schedule_agent.ts`
|
||
|
||
当前已实现能力：
|
||
|
||
1. `/assistant` 页面本身很薄，核心能力基本都收敛在 `AssistantPanel` 中，便于后续继续复用为嵌入态或独立页态。
|
||
2. 已接通的对话与上下文接口包括：
|
||
- `POST /api/v1/agent/chat`
|
||
- `GET /api/v1/agent/conversation-list`
|
||
- `GET /api/v1/agent/conversation-meta`
|
||
- `GET /api/v1/agent/conversation-history`
|
||
- `GET /api/v1/agent/context-stats`
|
||
- `GET /api/v1/agent/conversation-timeline`
|
||
3. 已接通的排程结果相关接口包括：
|
||
- `GET /api/v1/agent/schedule-preview`
|
||
- `POST /api/v1/agent/schedule-state`
|
||
- `PUT /api/v1/task-class/apply-batch-into-schedule`
|
||
4. 输入区支持两类核心控制参数：`thinking` 模式（`auto / true / false`）与执行模式（`manual / always`）。
|
||
5. 对于智能编排类对话，前端可通过 `TaskClassPlanningPicker` 透传 `task_class_ids`，让 `newAgent` 直接以指定任务类启动规划。
|
||
6. 流式回复已支持区分正文、思考内容和结构化 `extra` 事件，并可将 `tool_call / tool_result / status / confirm_request / schedule_completed` 转成前端时间线展示。
|
||
7. 对话页已经具备确认覆盖层：收到确认事件后，前端可以在卡片上直接确认、拒绝或补充说明，再把 `confirm_action / resume` 透传回后端。
|
||
8. 当后端发出 `schedule_completed` 信号后，消息流中会展示排程结果卡片；点击后可拉取结构化预览，并在 `ScheduleFineTuneModal` 中继续拖拽微调。
|
||
9. 微调弹窗已经支持两种收口方式：先“暂存到 Redis 状态”，或按任务类分桶后正式应用到数据库。
|
||
10. 对话页已具备上下文窗口计量器，可展示 `msg0 ~ msg3 / total / budget` 统计，用于观察当前对话窗口消耗。
|
||
11. 历史消息与本地乐观态消息会合并，避免刷新历史时把当前页内正在看的流式消息直接抹掉。
|
||
12. 助手消息底部支持复制、重新生成、版本分页切换；用户消息支持复制与“改写后重新发送”，但不会覆盖旧消息。
|
||
13. 消息区实现了“自动跟随到底部 / 用户手动上滚后停止跟随”的双态滚动策略。
|
||
|
||
## 6.6 日程编排页 `/schedule`
|
||
|
||
对应文件：
|
||
|
||
- `frontend/src/views/ScheduleView.vue`
|
||
- `frontend/src/components/schedule/TaskClassSidebar.vue`
|
||
- `frontend/src/components/schedule/WeekPlanningBoard.vue`
|
||
- `frontend/src/components/schedule/CreateTaskClassDialog.vue`
|
||
- `frontend/src/api/scheduleCenter.ts`
|
||
|
||
当前已实现能力：
|
||
|
||
1. `/schedule` 仍然是一套独立于 `newAgent` 对话页的传统编排中心，主要承接任务类管理、粗排预览与正式应用。
|
||
2. 左侧为任务类侧栏，右侧为周课表/排程画板，支持单选与批量多选两种任务类操作模式。
|
||
3. 任务类侧栏支持获取任务类列表、展开详情、删除任务块、新建任务类弹窗，以及长列表滚动。
|
||
4. 周课表支持周次切换，当前前端将请求范围限制在 `1 ~ 24` 周，并且加入请求序列号保护，快速切周时只认最后一次响应。
|
||
5. 已接通的课表/编排相关接口包括：
|
||
- `GET /api/v1/schedule/week`
|
||
- `GET /api/v1/task-class/list`
|
||
- `GET /api/v1/task-class/get`
|
||
- `POST /api/v1/task-class/add`
|
||
- `DELETE /api/v1/task-class/delete-item`
|
||
- `GET /api/v1/schedule/smart-planning`
|
||
- `POST /api/v1/schedule/smart-planning-multi`
|
||
- `PUT /api/v1/task-class/apply-batch-into-schedule`
|
||
- `DELETE /api/v1/schedule/delete`
|
||
6. 智能编排结果当前分为单任务类粗排和多任务类批量粗排，结果先进入前端运行时预览态，而不会立即写入正式课表。
|
||
7. 预览态结果只保存在单页应用运行时内存中，不落 `localStorage / sessionStorage`；刷新页面会丢失，因此页面挂了 `beforeunload` 原生拦截提示。
|
||
8. 已请求过的周课表会缓存在前端内存中，切周时优先复用缓存，避免反复回源后端。
|
||
9. 预览态 `suggested` 任务支持拖拽调整位置，并会同步修改前端持有的预览 JSON，保证“用户看到的布局”和“最终提交给后端的布局”一致。
|
||
10. 对于可嵌入课程的预览任务，只有拖到允许嵌入的课程块上时才允许嵌入，不会把整块课程卡一起误拖走。
|
||
11. 多任务类粗排的正式应用采用“先按任务类分桶，再逐桶调用现有应用接口”的兼容策略，避免一次性重写整个后端应用协议。
|
||
|
||
## 6.7 当前前后端衔接边界
|
||
|
||
当前前端已经覆盖的主业务链路：
|
||
|
||
1. 登录 / 注册 / 自动续签 / 安全登出。
|
||
2. 首页四象限任务获取、创建、完成、撤销与今日日程展示。
|
||
3. `newAgent` 对话、历史会话、思考内容展示、消息重试、结构化时间线、确认覆盖层、上下文窗口计量。
|
||
4. AI 对话页中的排程结果卡片、结构化预览拉取、弹窗微调、暂存到 Redis 状态、正式应用到课表。
|
||
5. 传统 `/schedule` 页面中的任务类管理、智能粗排、批量粗排、拖拽预览、正式应用、删除日程。
|
||
6. `/prototype/tool-trace` 原型页，用于展示工具 trace 与交互形态。
|
||
|
||
当前仍明确留给后续迭代的部分：
|
||
|
||
1. “任务”独立页面与“设置”独立页面尚未接出。
|
||
2. AI 输入区已经预留附件上传按钮，但上传、解析、落盘、发送给模型的完整链路尚未接通。
|
||
3. `/assistant` 与 `/schedule` 目前还是两套并行入口，状态模型与交互语义尚未完全统一。
|
||
4. 课表导入流程入口虽然已预留，但还没有完整的导入页与导入向导。
|
||
5. 用户消息“修改后原地替换旧消息”的真正后端语义尚未实现，目前仍按“复制到输入框后再发送一条新消息”处理。
|
||
6. 原型页、预留目录和历史壳层代码还未进一步收敛清理，说明前端仍处在快速迭代期。
|
||
|
||
# 7 部署与监控
|
||
|
||
## 7.1 容器化部署方案
|
||
当前项目已经具备一套**“依赖栈容器化 + 应用进程宿主机运行”**的落地方案，适合本地联调、答辩演示和单机部署。
|
||
|
||
### 当前部署形态
|
||
|
||
当前根目录已经提供 `docker-compose.yml`，用于启动以下基础设施：
|
||
|
||
| 服务 | 端口 | 用途 |
|
||
| --- | --- | --- |
|
||
| MySQL 8.0 | `3306` | 主业务库，承载用户、任务、课表、对话、memory 等结构化数据 |
|
||
| Redis 7 | `6379` | 登录态、幂等键、会话缓存、Agent 快照、预览状态等 |
|
||
| Kafka 3.7 | `9092` | Outbox 事件总线，承接聊天持久化、token 统计、memory 抽取等异步事件 |
|
||
| etcd | `2379` | Milvus 元数据存储 |
|
||
| MinIO | `9000` / `9001` | Milvus 对象存储依赖 |
|
||
| Milvus Standalone | `19530` / `9091` | RAG / memory 向量检索引擎 |
|
||
| Attu | `8000` | Milvus 可视化管理台 |
|
||
| kafka-init | 无外部端口 | 启动时自动创建 `smartflow.agent.outbox` topic |
|
||
|
||
其中，`docker-compose.yml` 已经为 MySQL、Redis、Kafka、etcd、MinIO、Milvus 配好了 `healthcheck`，并通过 `depends_on.condition: service_healthy` 保证依赖按健康状态顺序启动。
|
||
|
||
### 推荐启动顺序
|
||
|
||
1. 先启动依赖栈：
|
||
|
||
```bash
|
||
docker compose up -d
|
||
```
|
||
|
||
2. 准备后端配置文件：
|
||
|
||
```bash
|
||
cd backend
|
||
cp config.example.yaml config.yaml
|
||
```
|
||
|
||
然后按实际环境修改以下配置：
|
||
|
||
1. `database`：MySQL 地址、用户名、密码、库名。
|
||
2. `redis`：Redis 地址、密码。
|
||
3. `kafka`：Broker 地址与 topic / groupID。
|
||
4. `jwt`：`accessSecret` 与 `refreshSecret`。
|
||
5. `agent`：模型名、`baseURL`、推理开关。
|
||
6. `rag` / `memory`：Milvus 地址、embedding 配置、memory 模式。
|
||
7. `websearch`：联网搜索 provider 与 API Key。
|
||
|
||
3. 启动后端：
|
||
|
||
```bash
|
||
cd backend
|
||
go run .
|
||
```
|
||
|
||
后端默认监听 `8080`，并提供健康检查接口：
|
||
|
||
```text
|
||
GET /api/v1/health
|
||
```
|
||
|
||
4. 启动前端：
|
||
|
||
```bash
|
||
cd frontend
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
前端默认运行在 `5173`，并通过 Vite 代理把 `/api` 转发到 `http://127.0.0.1:8080`。
|
||
|
||
### 当前方案的边界
|
||
|
||
1. **已容器化的部分**：MySQL、Redis、Kafka、Milvus 及其依赖。
|
||
2. **未容器化的部分**：Go 后端进程与 Vue 前端进程当前仍以宿主机方式运行，仓库中尚未提供后端/前端 Dockerfile。
|
||
3. **因此更准确的表述**：当前项目已经完成“基础设施容器化”，但还没有做到“整站一键镜像化部署”。
|
||
4. **如果后续继续工程化**：优先补 `backend/Dockerfile`、`frontend/Dockerfile` 与生产态反向代理配置，再把前后端服务一并纳入 compose 编排。
|
||
|
||
## 7.2 性能监控&统计
|
||
当前项目已经接入了一套**轻量级、以日志和内存计数器为主的观测方案**，但还没有完整接入 Prometheus / Grafana 这类统一监控平台。
|
||
|
||
### 当前已具备的监控能力
|
||
|
||
1. **基础健康检查**：
|
||
- 后端提供 `GET /api/v1/health`。
|
||
- Docker Compose 为 MySQL、Redis、Kafka、etcd、MinIO、Milvus 提供了容器级健康检查。
|
||
2. **应用日志观测**：
|
||
- Gin 默认开启 `Logger + Recovery`，可覆盖 HTTP 请求与 panic 恢复。
|
||
- Outbox / Kafka、RAG、memory、newAgent 执行链路都已在关键节点输出结构化或半结构化日志。
|
||
3. **RAG 运行观测**：
|
||
- `backend/cmd/start.go` 中已为 RAG runtime 注入 `LoggerObserver`。
|
||
- 当前可观测向量检索、召回、Milvus 建表/查表、fallback 等运行事件。
|
||
4. **Memory 模块计数器**：
|
||
- memory 模块已经实现 `MetricsRegistry` 这类轻量内存计数器。
|
||
- 当前已覆盖的统计项包括：
|
||
- `memory_job_total`
|
||
- `memory_job_retry_total`
|
||
- `memory_decision_total`
|
||
- `memory_decision_fallback_total`
|
||
- `memory_retrieve_hit_total`
|
||
- `memory_retrieve_dedup_drop_total`
|
||
- `memory_inject_item_total`
|
||
- `memory_rag_fallback_total`
|
||
- `memory_manage_total`
|
||
- `memory_cleanup_run_total`
|
||
- `memory_cleanup_archived_total`
|
||
5. **Agent 链路观测**：
|
||
- `newAgent` 主链路会记录 chat / plan / execute / rough_build / order_guard / deliver 等阶段日志。
|
||
- 对话时间线、确认事件、排程结果卡片、schedule preview 状态，也都能通过业务接口和 Redis 快照回看。
|
||
6. **向量库侧辅助观测**：
|
||
- Milvus 自带 `9091` 健康/指标端口。
|
||
- Attu 已在 compose 中接入，可用于观察 collection、索引与向量数据状态。
|
||
|
||
### 当前更适合关注的关键指标
|
||
|
||
现阶段最有价值的观测重点，不是“大而全”的机器监控，而是以下业务指标：
|
||
|
||
1. **Agent 可用性**：`/api/v1/health` 是否可用，`/agent/chat` 首字延迟是否异常。
|
||
2. **事件总线稳定性**：Kafka topic 是否就绪，Outbox 是否持续消费，是否出现重试堆积。
|
||
3. **memory 质量**：命中率、fallback 次数、decision fallback 次数、job retry 次数。
|
||
4. **RAG 检索质量**：Milvus 查询是否超时、是否频繁降级到 MySQL、topK/threshold 是否合理。
|
||
5. **排程链路稳定性**：rough build 失败率、order guard 是否频繁触发、preview 是否能成功落盘。
|
||
|
||
### 当前仍未完成的部分
|
||
|
||
1. 还没有把 memory 计数器正式暴露成 Prometheus `/metrics` 接口。
|
||
2. 还没有统一的 Grafana 看板、告警规则与告警分级。
|
||
3. 还没有把 Gin、Kafka、RAG、memory、newAgent 的指标统一汇聚到同一套 tracing / metrics 平台。
|
||
4. 当前更偏“开发期可诊断”而不是“生产期可运营”的观测体系。
|
||
|
||
因此，现阶段 README 中更准确的结论是：**项目已经具备基础健康检查、关键日志观测和 memory/RAG 轻量指标能力，但尚未完成完整生产级监控平台建设。**
|
||
|
||
# 8 快速开始
|
||
|
||
## 8.1 启动前端开发环境
|
||
|
||
前端目录在 `frontend/`，本地开发步骤如下：
|
||
|
||
```bash
|
||
cd frontend
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
默认启动信息：
|
||
|
||
1. Vite 开发端口：`5173`
|
||
2. 开发代理目标：`http://127.0.0.1:8080`
|
||
3. 因此前端本地联调前，需要先确保后端服务已经启动在 `8080`
|
||
|
||
## 8.2 前端生产构建
|
||
|
||
```bash
|
||
cd frontend
|
||
npm run build
|
||
npm run preview
|
||
```
|
||
|
||
说明：
|
||
|
||
1. `npm run build` 会先执行 `vue-tsc -b` 做类型检查，再执行 `vite build`。
|
||
2. 当前构建是可通过的；但由于主包仍然偏大，Vite 会给出 chunk size warning，这属于现阶段可接受状态。
|
||
|
||
## 8.3 建议的前后端联调顺序
|
||
|
||
建议按下面顺序启动和验证：
|
||
|
||
1. 启动后端服务，确认 `http://127.0.0.1:8080` 可用。
|
||
2. 启动前端 `npm run dev`。
|
||
3. 先验证 `/auth` 的登录注册链路。
|
||
4. 再验证 `/dashboard` 的任务与今日日程。
|
||
5. 再验证 `/assistant` 的 SSE 对话、历史消息、重试分页与深度思考展示。
|
||
6. 最后验证 `/schedule` 的任务类、周课表、智能粗排、拖拽预览与正式应用。
|