docs: 更新文档及配置

更新 README 和 README_EN 文档,添加 tts_providers.json 文件说明和免责声明。修改 fish-audio.json 配置中的模型名称。添加 GPL-3.0 许可证文件。
This commit is contained in:
hex2077
2025-08-10 22:32:48 +08:00
parent 78d4c81173
commit 924ff6ef83
4 changed files with 759 additions and 7 deletions

View File

@@ -34,7 +34,7 @@
打开您的终端或命令提示符,使用 pip 安装所需的 Python 库:
```bash
pip install requests openai
pip install requests openai pydub msgpack
```
---
@@ -150,6 +150,42 @@ python podcast_generator.py --api-key sk-xxxxxx --model gpt-4o --threads 4
* `apiUrl`: 您的 TTS 服务 API 端点。`{{text}}` 将被替换为对话文本,`{{voiceCode}}` 将被替换为角色的语音代码。
* `turnPattern`: 定义角色对话的**轮流模式**,例如 `random` (随机) 或 `sequential` (顺序)。
### `tts_providers.json` 文件说明
`tts_providers.json` 文件用于存储各种 TTS 服务提供商的认证信息,如 API 密钥等。该文件在以下场景中被使用:
1.`check/` 目录下的各种 TTS 服务测试脚本中,用于获取相应的认证信息
2.`podcast_generator.py` 脚本中,用于获取特定 TTS 服务的额外配置参数
该文件的结构如下:
```json
{
"index": {
"api_key": null
},
"edge": {
"api_key": null
},
"doubao": {
"X-Api-App-Id": "null",
"X-Api-Access-Key": "null"
},
"fish": {
"api_key": "null"
},
"minimax": {
"group_id": "null",
"api_key": "null"
},
"gemini": {
"api_key": "null"
}
}
```
注意事项:
* 实际使用时,请将 `"null"` 替换为相应的认证信息
* `tts_providers-local.json` 是一个本地配置文件示例,包含了实际的认证信息(请勿将其提交到版本控制系统中)
---
## 🔌 TTS (Text-to-Speech) 服务集成
@@ -169,13 +205,14 @@ python podcast_generator.py --api-key sk-xxxxxx --model gpt-4o --threads 4
### 🌐 网络 TTS 接口支持
本项目也可以轻松配置集成各种网络 TTS 服务,只需确保您的 `apiUrl` 配置符合服务提供商的要求。常见的支持服务包括:
* **豆包 TTS (Doubao TTS)**
* **Minimax TTS**
* **Fish Audio TTS**
* **豆包 TTS (Doubao TTS)**
* **Gemini TTS**
* **OpenAI TTS**(计划中)
* **Azure TTS**(计划中)
* **Google Cloud Text-to-Speech (Vertex AI)**(计划中)
---
## 🎉 输出成果
@@ -247,3 +284,6 @@ python podcast_generator.py --api-key sk-xxxxxx --model gpt-4o --threads 4
└── tts_adapters.py # TTS 适配器文件
```
## 📝 免责声明
本项目是根据 GNU 通用公共许可证 v3.0 (GPL-3.0) 授权的自由软件。我们不提供任何明示或暗示的担保,包括但不限于对适销性、特定用途的适用性和非侵权性的担保。在任何情况下,作者或版权持有者均不对因使用本软件而产生的任何直接、间接、附带、特殊、惩戒性或后果性损害(包括但不限于采购替代商品或服务;系统故障或数据丢失;业务中断;利润损失)承担责任,即使事先已被告知此类损害的可能性。您使用本软件的风险完全由您自己承担。本软件按"现状"提供,不附带任何形式的担保。在使用本软件前,请确保您已阅读并理解本免责声明的所有条款。如果您不同意这些条款,请勿使用本软件。本项目中使用的第三方服务(如 OpenAI API、TTS 服务等)可能有其自己的使用条款和限制,用户需自行承担使用这些服务的责任。我们不对任何第三方服务的可用性、性能或安全性做出任何承诺或保证。本项目仅供学习和研究目的使用,不应用于任何商业用途或生产环境。我们不对使用本项目产生的任何后果承担责任。用户在使用本项目时,应遵守所有适用的法律法规。任何违反法律法规的行为均由用户自行承担全部责任。本免责声明的解释权归项目开发者所有。我们保留随时修改本免责声明的权利,恕不另行通知。修改后的免责声明将在项目仓库中发布,用户应定期查看以了解最新版本。继续使用本项目即表示您接受并同意遵守最新版本的免责声明条款。如果您对本免责声明有任何疑问或需要更多信息,请通过项目仓库中的联系方式与我们取得联系。