# speech_convert

**Repository Path**: coderxslee/speech_convert

## Basic Information

- **Project Name**: speech_convert
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-09
- **Last Updated**: 2025-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Speech Convert

基于 FunASR 的统一语音识别和文本处理服务，提供 WebSocket 语音识别和 HTTP API 文本处理功能。

## 🎯 项目特点

- **统一入口**: 一个 `main.py` 文件管理所有服务
- **完整功能**: WebSocket 语音识别 + HTTP API 文本处理
- **现代化架构**: 基于 FastAPI 和 loguru 的现代化设计
- **开发友好**: VS Code 调试配置和热重载支持
- **生产就绪**: 完整的错误处理和生命周期管理

## 🚀 快速开始

```bash
# 安装依赖
uv venv
source .venv/bin/activate  # Linux/Mac

# 启动服务
python -m speech_convert.main

# 访问服务
# API 文档: http://localhost:8000/docs
# 健康检查: http://localhost:8000/health
# WebSocket: ws://localhost:8000/ws
```

## 📡 服务端点

- **API 文档**: http://localhost:8000/docs
- **健康检查**: http://localhost:8000/health
- **根路径**: http://localhost:8000/
- **WebSocket**: ws://localhost:8000/ws
- **文本处理 API**: http://localhost:8000/api/v1/text

## 📚 文档导航

### 🚀 快速开始
- **[启动指南](docs/启动指南.md)** - 完整的启动和调试指南
  - 命令行启动方式
  - VS Code 调试配置
  - 常见问题解决
  - 自定义配置

### 🏗️ 项目架构
- **[项目结构](docs/项目结构.md)** - 项目目录结构和核心文件说明
  - 详细的目录结构图
  - 核心文件功能说明
  - 开发工具使用
  - 架构特点介绍

- **[架构简化说明](docs/架构简化说明.md)** - 架构演进和简化过程
  - 简化前后对比
  - 完成的工作内容
  - 简化后的优势
  - 保留的功能

### 🔧 功能使用
- **[文本处理API文档](docs/文本处理API文档.md)** - API 使用说明
  - API 端点说明
  - 请求/响应格式
  - 使用示例
  - 错误处理

- **[日志系统使用指南](docs/日志系统使用指南.md)** - 日志配置和使用
  - 日志系统架构
  - 配置选项
  - 使用示例
  - 最佳实践

### 📊 性能与优化
- **[性能优化总结](docs/性能优化总结.md)** - 性能优化指南
  - 性能测试结果
  - 优化策略
  - 监控指标
  - 最佳实践

### 🔬 技术架构
- **[README2.md](docs/README2.md)** - 技术架构流程图
  - 语音识别处理流程
  - Online vs Offline 处理
  - 会议文字处理架构
  - Mermaid 流程图

## 🎯 按使用场景选择文档

### 新用户入门
1. **[启动指南](docs/启动指南.md)** - 学习如何启动项目
2. **[项目结构](docs/项目结构.md)** - 了解项目架构
3. **[文本处理API文档](docs/文本处理API文档.md)** - 学习使用 API

### 开发者
1. **[启动指南](docs/启动指南.md)** - VS Code 调试配置
2. **[日志系统使用指南](docs/日志系统使用指南.md)** - 日志配置
3. **[性能优化总结](docs/性能优化总结.md)** - 性能调优

### 运维人员
1. **[启动指南](docs/启动指南.md)** - 生产环境部署
2. **[项目结构](docs/项目结构.md)** - 部署结构了解
3. **[性能优化总结](docs/性能优化总结.md)** - 性能监控

### 架构师
1. **[架构简化说明](docs/架构简化说明.md)** - 架构演进历史
2. **[README2.md](docs/README2.md)** - 技术架构设计
3. **[项目结构](docs/项目结构.md)** - 模块组织方式

## 🔗 快速链接

| 文档 | 用途 | 适用人群 |
|------|------|----------|
| [启动指南](docs/启动指南.md) | 项目启动和调试 | 所有用户 |
| [项目结构](docs/项目结构.md) | 了解项目架构 | 开发者、运维 |
| [文本处理API文档](docs/文本处理API文档.md) | API 使用说明 | 开发者、用户 |
| [日志系统使用指南](docs/日志系统使用指南.md) | 日志配置 | 开发者、运维 |
| [性能优化总结](docs/性能优化总结.md) | 性能调优 | 开发者、运维 |
| [架构简化说明](docs/架构简化说明.md) | 架构演进 | 架构师、开发者 |
| [README2.md](docs/README2.md) | 技术架构 | 架构师、开发者 |

## 💡 使用建议

1. **首次使用**: 从 [启动指南](docs/启动指南.md) 开始
2. **开发调试**: 重点关注 VS Code 配置部分
3. **API 使用**: 参考 [文本处理API文档](docs/文本处理API文档.md)
4. **性能问题**: 查看 [性能优化总结](docs/性能优化总结.md)
5. **架构理解**: 阅读 [架构简化说明](docs/架构简化说明.md)

## 🛠️ 开发工具

### 代码质量检查
```bash
# 检查代码质量并自动修复
ruff check src/ --fix

# 格式化代码
ruff format src/

# 运行测试
pytest
```

### 启动脚本
```bash
# 使用启动脚本
./scripts/start_fastapi.sh

# 开发模式
./scripts/start_fastapi.sh -r -l debug
```

## 📋 主要特性

- **统一入口**: 一个 `main.py` 文件管理所有服务
- **完整日志**: 基于 loguru 的现代化日志系统
- **开发友好**: VS Code 调试配置和热重载支持
- **生产就绪**: 完整的错误处理和生命周期管理
- **文档完善**: 详细的使用文档和示例

## 🤝 贡献

如果您发现文档中的问题或有改进建议，欢迎提交 Issue 或 Pull Request！

---

**注意**: 本项目采用简化的架构设计，所有功能通过统一的 `main.py` 入口点管理，大大简化了使用和维护的复杂度。