- 新增 12-鉴权体系设计.md,详细描述 JWT 双 token 轮转认证机制 - 更新架构设计文档,补充认证设计章节的安全机制和配置说明 - 更新接口文档,补充 Refresh Token Rotation 安全机制和前端集成示例 - 更新文档索引,添加新文档的推荐阅读顺序
34 lines
2.2 KiB
Markdown
34 lines
2.2 KiB
Markdown
# CamTalk 设计文档
|
||
|
||
CamTalk 是一款多模态实时 AI 视觉对话助手。用户通过摄像头和麦克风与 AI 交互,AI 理解视觉场景和语音输入后,以文字和语音形式给出自然回应。
|
||
|
||
## 文档索引
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [01-架构设计](01-架构设计.md) | 系统架构、技术栈、模块设计、数据库、部署架构(含 Mermaid 图) |
|
||
| [02-接口文档](02-接口文档.md) | WebSocket 协议、REST API、AI 服务层、Eino 编排器、Session Manager、配置管理、数据模型、错误码 |
|
||
| [03-技术选型](03-技术选型.md) | 各技术的选型对比与决策理由(含 Eino 框架选型) |
|
||
| [04-用户故事](04-用户故事.md) | P0/P1/P2 用户故事、验收标准 |
|
||
| [05-语音交互](05-语音交互.md) | VAD → STT → LLM → TTS 全链路、延迟优化 |
|
||
| [06-视觉理解](06-视觉理解.md) | 帧采样策略、图像编码、多模态 LLM 输入机制 |
|
||
| [07-成本控制](07-成本控制.md) | 智能采样、端云协同、模型分级、缓存复用 |
|
||
| [08-功能创意](08-功能创意.md) | 未来功能创意清单 |
|
||
| [09-技术名词解释](09-技术名词解释.md) | 前端/后端/AI 服务/Eino 框架技术名词简明解释 |
|
||
| [10-Eino重构方案](10-Eino重构方案.md) | Eino Graph 替换手写 goroutine 管道的设计方案 |
|
||
| [11-Eino框架技术文档](11-Eino框架技术文档.md) | Eino 框架在 CamTalk 中的使用指南(Graph、Lambda、Callback、State) |
|
||
| [12-鉴权体系设计](12-鉴权体系设计.md) | JWT 双 token 轮转认证、bcrypt 密码哈希、Refresh Token Rotation、安全机制 |
|
||
|
||
|
||
## 推荐阅读顺序
|
||
|
||
1. **01-架构设计** — 理解三层架构、技术栈和模块全貌
|
||
2. **02-接口文档** — 前后端通信契约,实现时的最高依据
|
||
3. **03-技术选型** — 了解为什么选这些技术(含 Eino 框架)
|
||
4. **04-用户故事** — 明确功能优先级
|
||
5. **05~07** — 各技术领域的详细设计
|
||
6. **09-技术名词解释** — 遇到不熟悉的名词时查阅
|
||
7. **10~12** — Eino 重构相关(方案、框架文档、实施记录)
|
||
8. **12-鉴权体系设计** — 认证授权机制详细设计(JWT、bcrypt、Refresh Token Rotation)
|
||
|