diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..cfc637e2545124853f5e5b962dd2cb2950bddeb7 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,68 @@ +# 文本转语音服务 + +这是一个基于 FastAPI 的文本转语音服务,提供简洁的 REST API 接口用于语音合成。项目使用 Python 编写,支持异步处理和多线程任务调度。 + +## 功能特性 + +- 提供 REST API 接口控制 TTS 服务 +- 支持服务状态查询、启动和停止 +- 支持多语言文本转语音 +- 智能文本分段处理 +- 异步任务队列处理 + +## 目录结构 + +``` +. +├── api/ # API 路由和应用初始化 +├── core/ # 核心功能模块 +├── test_client.py # 测试客户端和示例 +└── requirements.txt # 依赖包列表 +``` + +## 安装指南 + +1. 安装依赖: +```bash +pip install -r requirements.txt +``` + +2. 启动服务: +```bash +python main.py +``` + +## 使用说明 + +### API 接口 + +- `GET /status` - 查询服务状态 +- `POST /start` - 启动 TTS 服务 +- `POST /stop` - 停止 TTS 服务 +- `POST /convert` - 执行文本转语音转换 + +### 请求示例 + +```json +{ + "text": "你好,这是一条测试消息", + "speaker": "female", + "language": "zh-cn" +} +``` + +## 测试 + +运行测试: +```bash +python test_client.py +``` + +交互模式: +```bash +python test_client.py --interactive +``` + +## 许可证 + +本项目使用 MIT 许可证,详细信息请查看 LICENSE 文件。 \ No newline at end of file