Skip to content

julesChu12/voice-memory

Repository files navigation

Voice Memory 项目文档

项目: 可打断的实时语音AI助手 日期: 2025-12-29 状态: 文档完成,待开发实现


📚 文档结构

docs/
├── README.md (本文件)
├── 01-产品/                  # 产品需求和功能定义
├── 02-技术调研/              # 技术方案调研
├── 03-Python实现/            # Python版本文档(学习用)
└── 04-Golang实现/            # Golang版本文档(实现用)⭐

📁 目录说明

01-产品/

  • 产品文档.md - 产品定位、核心功能、用户画像、路线图

02-技术调研/

  • 技术调研文档.md - 唤醒词、STT、TTS、AI服务、存储方案调研
  • 可打断技术实现方案.md - Phase 2的可打断功能设计方案

03-Python实现/

用于学习Python和项目架构,包含:

  • 技术栈决策文档.md - FastAPI技术栈
  • 核心代码选择与使用说明.md - Python代码示例
  • 开发实施指南.md - Python项目结构
  • API设计文档.md - API接口设计
  • 数据模型文档.md - SQLAlchemy数据模型
  • 部署与运维文档.md - Python部署方案

04-Golang实现/ ⭐

用于实际项目实现,包含:

  • AI项目启动指南_Go.md - 🚀 AI工作主入口文档
  • 技术栈决策文档_Go.md - Gin技术栈选择
  • 核心代码示例_Go.md - Golang完整代码示例
  • 开发实施指南_Go.md - 项目结构和开发流程
  • API设计文档_Go.md - REST + WebSocket API设计
  • 数据模型文档_Go.md - SQLite数据模型
  • 部署与运维文档_Go.md - Systemd/Docker部署

🚀 快速开始

给AI助手使用

直接发送以下指令

请按照 docs/04-Golang实现/AI项目启动指南_Go.md 的指引,
完整实现 Voice Memory 项目。

给开发者阅读

按顺序阅读

  1. 01-产品/产品文档.md - 了解项目需求
  2. 02-技术调研/技术调研文档.md - 了解技术方案
  3. 04-Golang实现/AI项目启动指南_Go.md - 开始实现

📊 文档统计

分类 文档数 用途
产品 1 需求定义
技术调研 2 方案设计
Python实现 6 学习参考
Golang实现 7 实际实现
总计 16

🎯 MVP范围

包含:

  • ✅ 语音输入 → OpenAI Whisper API → 文本
  • ✅ 文本 → Claude 3.5 API → AI回复
  • ✅ AI回复 → OpenAI TTS API → 语音输出
  • ✅ 基础记忆存储 (SQLite)
  • ✅ 简单文本搜索

不包含 (Phase 2):

  • ❌ 可打断/插话功能
  • ❌ 本地STT/TTS模型
  • ❌ 唤醒词检测
  • ❌ 向量语义搜索

🛠️ 技术栈

前端: Web PWA (HTML5 + Vanilla JS)
后端: Golang + Gin
数据库: SQLite3 + sqlite-vss
AI: Claude 3.5 (Haiku/Sonnet)
STT: OpenAI Whisper API
TTS: OpenAI TTS API

📝 更新记录

  • 2025-12-29: 创建完整文档体系(Python + Golang双版本)
  • 2025-12-29: 文档分类整理完成

📞 联系方式

如有疑问或建议,请参考 04-Golang实现/AI项目启动指南_Go.md

About

Voice Memory - 语音知识管理系统

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors