Spaces:
Running
Running
Delete API_DOCUMENTATION.md
Browse files- API_DOCUMENTATION.md +0 -69
API_DOCUMENTATION.md
DELETED
|
@@ -1,69 +0,0 @@
|
|
| 1 |
-
# Genie-TTS API 接口文档
|
| 2 |
-
|
| 3 |
-
本文档列出了 `Genie-TTS` 在 Hugging Face Space 上部署的 API 接口及参数说明。
|
| 4 |
-
|
| 5 |
-
## 1. 动态加载模型 (`/load_model`)
|
| 6 |
-
用于在不重启服务的情况下，从指定目录加载新的角色模型。
|
| 7 |
-
|
| 8 |
-
- **URL**: `POST /load_model`
|
| 9 |
-
- **Content-Type**: `application/x-www-form-urlencoded`
|
| 10 |
-
|
| 11 |
-
### 参数说明：
|
| 12 |
-
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|
| 13 |
-
| :--- | :--- | :--- | :--- | :--- |
|
| 14 |
-
| `character_name` | `string` | 是 | - | 角色名称（如 "mzm"） |
|
| 15 |
-
| `model_path` | `string` | 是 | - | 相对于 `/app` 的路径（如 "models/mzm"） |
|
| 16 |
-
| `language` | `string` | 否 | `zh` | 模型默认语言 |
|
| 17 |
-
|
| 18 |
-
---
|
| 19 |
-
|
| 20 |
-
## 2. 上传音频并合成 (`/upload_and_tts`)
|
| 21 |
-
上传一段参考音频文件，并结合输入的文本生成语音。
|
| 22 |
-
|
| 23 |
-
- **URL**: `POST /upload_and_tts`
|
| 24 |
-
- **Content-Type**: `multipart/form-data`
|
| 25 |
-
|
| 26 |
-
### 参数说明：
|
| 27 |
-
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|
| 28 |
-
| :--- | :--- | :--- | :--- | :--- |
|
| 29 |
-
| `character_name` | `string` | 否 | `Default` | 使用的模型角色名 |
|
| 30 |
-
| `prompt_text` | `string` | 是 | - | 参考音频对应的文本内容 |
|
| 31 |
-
| `language` | `string` | 否 | `zh` | 参考音频的语言类型 |
|
| 32 |
-
| `text` | `string` | 是 | - | 目标合成文本 |
|
| 33 |
-
| `text_lang` | `string` | 否 | - | 目标文本语言（用于跨语言合成） |
|
| 34 |
-
| `speed` | `number` | 否 | `1.0` | **语速调节** (0.5 - 2.0) |
|
| 35 |
-
| `file` | `binary` | 是 | - | 参考音频文件 (wav, flac 等) |
|
| 36 |
-
|
| 37 |
-
---
|
| 38 |
-
|
| 39 |
-
## 3. 通用 TTS 接口 (`/tts`)
|
| 40 |
-
使用服务器已加载的模型和默认参考音频生成语音。
|
| 41 |
-
|
| 42 |
-
- **URL**: `POST /tts`
|
| 43 |
-
- **Content-Type**: `application/x-www-form-urlencoded`
|
| 44 |
-
|
| 45 |
-
### 参数说明：
|
| 46 |
-
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|
| 47 |
-
| :--- | :--- | :--- | :--- | :--- |
|
| 48 |
-
| `text` | `string` | 是 | - | 目标合成文本 |
|
| 49 |
-
| `character_name` | `string` | 否 | `Base` | 指定角色名 |
|
| 50 |
-
| `prompt_text` | `string` | 否 | - | 覆盖默认的参考文本 |
|
| 51 |
-
| `prompt_lang` | `string` | 否 | `zh` | 参考音频语言 |
|
| 52 |
-
| `text_lang` | `string` | 否 | - | 目标文本语言 |
|
| 53 |
-
| `speed` | `number` | 否 | `1.0` | **语速调节** (0.5 - 2.0) |
|
| 54 |
-
| `use_default_ref` | `boolean`| 否 | `true` | 是否使用默认参考音频 |
|
| 55 |
-
|
| 56 |
-
---
|
| 57 |
-
|
| 58 |
-
## 4. 健康检查 (`/health`)
|
| 59 |
-
查看服务在线状态及已加载的模型列表。
|
| 60 |
-
|
| 61 |
-
- **URL**: `GET /health`
|
| 62 |
-
|
| 63 |
-
### 响应示例：
|
| 64 |
-
```json
|
| 65 |
-
{
|
| 66 |
-
"status": "ok",
|
| 67 |
-
"models": ["Base", "god", "mzm"]
|
| 68 |
-
}
|
| 69 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|