本教程为社区贡献，不属于 Open WebUI 官方支持。它仅作为如何针对特定用例自定义 Open WebUI 的演示。想要贡献？请查看贡献教程。
将 openai-edge-tts 🗣️ 集成到 Open WebUI
什么是 openai-edge-tts？
OpenAI Edge TTS 是一个文本转语音 (TTS) API，它模仿了 OpenAI API 端点，可在允许自定义端点 URL 的场景中（如 Open WebUI）作为直接替代方案。
它使用了 edge-tts 库，该库利用了 Edge 浏览器免费的“大声朗读”功能，通过模拟向 Microsoft / Azure 发送请求，免费获得极高质量的文本转语音。
它与 'openedai-speech' 有什么不同？
与 openedai-speech 类似，openai-edge-tts 是一个模仿 OpenAI API 端点的文本转语音 API 端点。
openedai-speech 是一个更全面的选项，支持完全离线的语音生成，并提供多种模式选择。
openai-edge-tts 是一个更简单的选项，使用名为 edge-tts 的 Python 包来生成音频。
环境要求
- 系统已安装 Docker
- Open WebUI 正在运行
⚡️ 快速开始
在无需进行任何配置的情况下，最简单的启动方式是运行以下命令：
docker run -d -p 5050:5050 travisvn/openai-edge-tts:latest
这将在 5050 端口运行服务，并使用所有默认配置。
设置 Open WebUI 使用 openai-edge-tts
- 打开 管理员面板 并转到 设置 -> 音频
- 将您的 TTS 设置 配置为与下方截图一致
- 注意：您可以在此处指定 TTS 声音
默认 API 密钥是字符串 your_api_key_here。如果您不需要额外的安全性，则无需更改该值。
就这样！您可以到此为止了。
如果您觉得 OpenAI Edge TTS 对您有帮助，请在 GitHub 上点个 ⭐️
使用 Python 运行
🐍 使用 Python 运行
如果您更愿意直接使用 Python 运行本项目，请按照以下步骤设置虚拟环境、安装依赖并启动服务器。
1. 克隆仓库
git clone https://github.com/travisvn/openai-edge-tts.git
cd openai-edge-tts
2. 设置虚拟环境
创建并激活虚拟环境以隔离依赖：
# macOS/Linux
python3 -m venv venv
source venv/bin/activate
# Windows
python -m venv venv
venv\Scripts\activate
3. 安装依赖
使用 pip 安装 requirements.txt 中列出的所需包：
pip install -r requirements.txt
4. 配置环境变量
在根目录下创建一个 .env 文件并设置以下变量：
API_KEY=your_api_key_here
PORT=5050
DEFAULT_VOICE=en-US-AvaNeural
DEFAULT_RESPONSE_FORMAT=mp3
DEFAULT_SPEED=1.0
DEFAULT_LANGUAGE=en-US
REQUIRE_API_KEY=True
REMOVE_FILTER=False
EXPAND_API=True
5. 启动服务器
配置完成后，启动服务器：
python app/server.py
服务器将开始在 http://localhost:5050 运行。
6. 测试 API
您现在可以在 http://localhost:5050/v1/audio/speech 和其他可用端点与 API 交互。请参阅“使用详情”部分获取请求示例。
使用详情
端点：/v1/audio/speech (别名 /audio/speech)
根据输入文本生成音频。可用参数：
必填参数：
- input (字符串)：要转换为音频的文本（最多 4096 个字符）。
可选参数：
- model (字符串)：设置为 "tts-1" 或 "tts-1-hd"（默认：
"tts-1"）。 - voice (字符串)：OpenAI 兼容的声音（alloy, echo, fable, onyx, nova, shimmer）或任何有效的
edge-tts声音（默认："en-US-AvaNeural"）。 - response_format (字符串)：音频格式。选项：
mp3,opus,aac,flac,wav,pcm（默认：mp3）。 - speed (数字)：播放速度（0.25 到 4.0）。默认值为
1.0。
您可以在 tts.travisvn.com 浏览可用声音并试听样本预览。
使用 curl 请求并将输出保存为 mp3 文件的示例：
curl -X POST http://localhost:5050/v1/audio/speech \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_api_key_here" \
-d '{
"input": "Hello, I am your AI assistant! Just let me know how I can help bring your ideas to life.",
"voice": "echo",
"response_format": "mp3",
"speed": 1.0
}' \
--output speech.mp3
或者，与 OpenAI API 端点参数保持一致：
curl -X POST http://localhost:5050/v1/audio/speech \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_api_key_here" \
-d '{
"model": "tts-1",
"input": "Hello, I am your AI assistant! Just let me know how I can help bring your ideas to life.",
"voice": "alloy"
}' \
--output speech.mp3
非英语语言的示例：
curl -X POST http://localhost:5050/v1/audio/speech \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_api_key_here" \
-d '{
"model": "tts-1",
"input": "じゃあ、行く。電車の时间、調べておくよ。",
"voice": "ja-JP-KeitaNeural"
}' \
--output speech.mp3
额外端点
- POST/GET /v1/models：列出可用的 TTS 模型。
- POST/GET /v1/voices：列出特定语言/地区的
edge-tts声音。 - POST/GET /v1/voices/all：列出所有
edge-tts声音，包含语言支持信息。
/v1 现在是可选的。
此外，还提供了 Azure AI Speech 和 ElevenLabs 的端点，以便在未来 Open WebUI 允许这些选项使用自定义 API 端点时提供支持。
可以通过设置环境变量 EXPAND_API=False 来禁用这些功能。
🐳 Docker 快速配置
您可以在用于运行项目的命令中配置环境变量：
docker run -d -p 5050:5050 \
-e API_KEY=your_api_key_here \
-e PORT=5050 \
-e DEFAULT_VOICE=en-US-AvaNeural \
-e DEFAULT_RESPONSE_FORMAT=mp3 \
-e DEFAULT_SPEED=1.0 \
-e DEFAULT_LANGUAGE=en-US \
-e REQUIRE_API_KEY=True \
-e REMOVE_FILTER=False \
-e EXPAND_API=True \
travisvn/openai-edge-tts:latest
Markdown 文本现在通过过滤器处理，以增强可读性和支持。
您可以通过设置环境变量 REMOVE_FILTER=True 来禁用此功能。
其他资源
有关 openai-edge-tts 的更多信息，您可以访问 GitHub 仓库。
如需直接支持，可以访问 Voice AI & TTS Discord。