sun
00460771c4
- 新增全局并发请求限制，最多同时处理10个TTS请求 - 更新健康检查接口，新增配置检查和统计信息返回 - 调整响应格式文档，仅保留wav格式支持说明 - 补充限流机制说明和触发后的响应示例 - 优化日志输出，限流时打印中文警告日志
252 lines
6.0 KiB
Markdown
252 lines
6.0 KiB
Markdown
# 字节跳动火山引擎TTS v3 API 转 OpenAI 兼容接口
|
||
|
||
## 项目简介
|
||
|
||
本项目将字节跳动火山引擎TTS（文本转语音）v3 API封装为OpenAI兼容的TTS API接口，使原本调用OpenAI TTS服务的应用可以无缝切换到火山引擎TTS服务。
|
||
|
||
### 主要特性
|
||
|
||
- ✅ 完全兼容OpenAI `/v1/audio/speech` API接口
|
||
- ✅ 支持火山引擎TTS v3 API（单向流式）
|
||
- ✅ 支持API Key鉴权方式
|
||
- ✅ 支持多种发音人和模型版本
|
||
- ✅ 内置速率限制和统计功能
|
||
- ✅ 支持配置API密钥验证
|
||
- ✅ 并发限制：最多同时处理10个请求（保护上游API）
|
||
- ✅ 跨平台支持（Windows/Linux/macOS）
|
||
|
||
## 文件说明
|
||
|
||
- `tts_server.go` - 主程序源码
|
||
- `.env.example` - 环境变量配置示例
|
||
- `go.mod` / `go.sum` - Go模块依赖
|
||
|
||
## 快速开始
|
||
|
||
### 前置要求
|
||
|
||
- Go 1.19 或更高版本
|
||
- 火山引擎账号并开通TTS服务
|
||
|
||
### 1. 编译程序
|
||
|
||
```bash
|
||
go build -o tts_server tts_server.go
|
||
```
|
||
|
||
### 2. 配置环境变量
|
||
|
||
复制 `.env.example` 为 `.env` 并填入你的配置：
|
||
|
||
```bash
|
||
cp .env.example .env
|
||
```
|
||
|
||
编辑 `.env` 文件，填入必要的配置参数。
|
||
|
||
### 3. 启动服务
|
||
|
||
```bash
|
||
# Windows
|
||
tts_server.exe
|
||
|
||
# Linux/macOS
|
||
./tts_server
|
||
```
|
||
|
||
服务默认监听 `8080` 端口。
|
||
|
||
## 环境变量配置
|
||
|
||
### 必需参数
|
||
|
||
| 变量名 | 说明 | 示例 |
|
||
|--------|------|------|
|
||
| `BYTEDANCE_TTS_API_KEY` | 火山引擎新版控制台 API Key | `your_api_key_here` |
|
||
| `BYTEDANCE_TTS_RESOURCE_ID` | 资源ID，决定模型版本 | `seed-tts-1.0` |
|
||
| `BYTEDANCE_TTS_SPEAKER` | 发音人（音色）ID | `zh_female_qingxin` |
|
||
|
||
### 可选参数
|
||
|
||
| 变量名 | 说明 | 默认值 |
|
||
|--------|------|--------|
|
||
| `BYTEDANCE_TTS_TIMEOUT` | 请求超时时间 | `30s` |
|
||
| `OPENAI_TTS_API_KEY` | OpenAI兼容接口的API密钥（逗号分隔支持多个） | 无 |
|
||
| `PORT` | 服务监听端口 | `8080` |
|
||
|
||
### Resource ID 说明
|
||
|
||
| Resource ID | 模型说明 |
|
||
|-------------|----------|
|
||
| `seed-tts-1.0` | 豆包语音合成模型1.0字符版 |
|
||
| `seed-tts-1.0-concurr` | 豆包语音合成模型1.0并发版 |
|
||
| `seed-tts-2.0` | 豆包语音合成模型2.0字符版 |
|
||
| `seed-icl-1.0` | 声音复刻1.0字符版 |
|
||
| `seed-icl-1.0-concurr` | 声音复刻1.0并发版 |
|
||
| `seed-icl-2.0` | 声音复刻2.0字符版 |
|
||
|
||
**注意：** 1.0音色只能搭配 `seed-tts-1.0` Resource ID，2.0音色只能搭配 `seed-tts-2.0` Resource ID。
|
||
|
||
## API 使用说明
|
||
|
||
### OpenAI 兼容接口
|
||
|
||
**端点：** `POST /v1/audio/speech`
|
||
|
||
**请求头：**
|
||
- `Content-Type: application/json`
|
||
- `Authorization: Bearer <你的API密钥>`（如果配置了OPENAI_TTS_API_KEY）
|
||
|
||
**请求体：**
|
||
```json
|
||
{
|
||
"model": "tts-1",
|
||
"input": "你好，这是一个测试文本",
|
||
"voice": "alloy",
|
||
"response_format": "wav",
|
||
"speed": 1.0
|
||
}
|
||
```
|
||
|
||
**参数说明：**
|
||
- `model` - 模型名称（OpenAI兼容，实际不影响）
|
||
- `input` - 要合成的文本
|
||
- `voice` - 发音人（OpenAI兼容，实际不影响）
|
||
- `response_format` - 输出格式：仅支持 `wav`
|
||
- `speed` - 语速：0.25 ~ 4.0
|
||
|
||
**示例调用：**
|
||
|
||
```bash
|
||
curl -X POST "http://localhost:8080/v1/audio/speech" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"model":"tts-1","input":"你好，世界","voice":"alloy","speed":1.0}' \
|
||
-o output.wav
|
||
```
|
||
|
||
### 健康检查（含统计信息）
|
||
|
||
```bash
|
||
curl http://localhost:8080/health
|
||
```
|
||
|
||
返回包含：服务状态、请求统计、错误记录、配置检查结果
|
||
|
||
## 限流机制
|
||
|
||
为保护上游火山引擎API，服务实现了两层限流保护：
|
||
|
||
### 1. 全局并发限制
|
||
- **限制**：最多同时处理 **10个** TTS请求
|
||
- **触发**：超过10个并发请求时
|
||
- **错误码**：`503 Service Unavailable`
|
||
- **说明**：确保不超过上游API的并发限制
|
||
|
||
### 2. IP速率限制
|
||
- **限制**：每个IP每分钟 **100个** 请求
|
||
- **触发**：单个IP调用过于频繁
|
||
- **错误码**：`429 Too Many Requests`
|
||
- **说明**：防止单个客户端滥用服务
|
||
|
||
### 触发限流时的响应
|
||
```json
|
||
{
|
||
"error": {
|
||
"message": "Server is busy, maximum concurrent requests reached.",
|
||
"type": "concurrency_limit_error",
|
||
"code": "max_concurrent_requests"
|
||
}
|
||
}
|
||
```
|
||
|
||
### 服务器日志
|
||
触发限流时服务器会输出中文警告日志：
|
||
- `警告: 已达到最大并发请求数限制，拒绝请求 - 客户端IP: x.x.x.x`
|
||
- `警告: 已超过IP速率限制，拒绝请求 - 客户端IP: x.x.x.x`
|
||
|
||
## 支持的发音人
|
||
|
||
具体发音人列表请参考火山引擎官方文档：
|
||
- 1.0音色：https://www.volcengine.com/docs/6561/97454
|
||
- 2.0音色：https://www.volcengine.com/docs/6561/1340515
|
||
|
||
## 常见问题
|
||
|
||
### 1. 如何获取鉴权信息？
|
||
|
||
- 登录火山引擎新版控制台
|
||
- 进入"语音合成"服务
|
||
- 创建应用并获取API Key
|
||
|
||
### 2. 端口被占用怎么办？
|
||
|
||
通过环境变量修改端口：
|
||
|
||
```bash
|
||
# Windows
|
||
set PORT=8081 && tts_server.exe
|
||
|
||
# Linux/macOS
|
||
PORT=8081 ./tts_server
|
||
```
|
||
|
||
### 3. 如何配置多个API密钥？
|
||
|
||
使用逗号分隔：
|
||
|
||
```bash
|
||
OPENAI_TTS_API_KEY=sk-key1,sk-key2,sk-key3
|
||
```
|
||
|
||
### 4. 查看日志
|
||
|
||
服务启动后会输出详细日志，包括：
|
||
- 服务启动信息
|
||
- 配置状态
|
||
- 请求统计信息
|
||
- 错误详情
|
||
|
||
## 部署建议
|
||
|
||
### Linux Systemd 服务
|
||
|
||
创建 `/etc/systemd/system/tts-server.service`：
|
||
|
||
```ini
|
||
[Unit]
|
||
Description=ByteDance TTS to OpenAI API Adapter
|
||
After=network.target
|
||
|
||
[Service]
|
||
Type=simple
|
||
User=www-data
|
||
WorkingDirectory=/www/wwwroot/tts-server
|
||
EnvironmentFile=/www/wwwroot/tts-server/.env
|
||
ExecStart=/www/wwwroot/tts-server/tts_server
|
||
Restart=always
|
||
RestartSec=10
|
||
|
||
[Install]
|
||
WantedBy=multi-user.target
|
||
```
|
||
|
||
启动服务：
|
||
|
||
```bash
|
||
sudo systemctl daemon-reload
|
||
sudo systemctl enable tts-server
|
||
sudo systemctl start tts-server
|
||
```
|
||
|
||
## 许可证
|
||
|
||
本项目采用非商业用途许可协议。您可以免费使用本软件用于非商业目的，但禁止用于任何商业活动。详细条款请参阅 [LICENSE](LICENSE) 文件。
|
||
|
||
## 技术支持
|
||
|
||
如有问题，请检查：
|
||
1. 环境变量配置是否正确
|
||
2. 网络是否能访问火山引擎TTS服务
|
||
3. 鉴权信息是否有效
|
||
4. Resource ID与Speaker是否匹配
|