开源项目安装与配置指南：OpenAI-Compatible Edge-TTS API

开源项目安装与配置指南：OpenAI-Compatible Edge-TTS API

openai-edge-tts Free, high-quality text-to-speech API endpoint to replace OpenAI, Azure, or ElevenLabs 项目地址: https://gitcode.com/gh_mirrors/op/openai-edge-tts

1. 项目基础介绍

OpenAI-Compatible Edge-TTS API 是一个开源项目，它提供了一个本地化的文本转语音（TTS）API，与OpenAI的TTS API端点兼容。该项目允许用户生成具有多种语音选项和播放速度的语音，与OpenAI API的功能类似。Edge-TTS使用Microsoft Edge的在线文本转语音服务，因此它是完全免费的。

主要编程语言：Python

2. 项目使用的关键技术和框架

• Python：用于实现API的主要编程语言。
• Docker：容器化技术，用于简化项目的部署和运行。
• edge-tts：基于Microsoft Edge的TTS服务，用于将文本转换为语音。
• Flask：一个轻量级的Web应用框架，用于创建API服务器。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装之前，请确保您的系统中安装了以下软件：

• Docker：用于容器化应用，确保可以使用Docker来运行API。
• Python (可选)：如果您选择不使用Docker，则需要安装Python来本地运行API。
• ffmpeg (可选)：如果您需要转换音频格式，则需要安装ffmpeg。

安装步骤

使用Docker安装

1. 克隆仓库：

   git clone https://github.com/travisvn/openai-edge-tts.git
   cd openai-edge-tts
   

2. 创建环境变量文件.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
   

   或者，复制默认的.env.example文件：

   cp .env.example .env
   

3. 使用Docker Compose启动API：

   docker compose up --build
   

   如果您想后台运行Docker Compose，可以使用以下命令：

   docker compose up -d
   

不使用Docker安装

1. 克隆仓库：

   git clone https://github.com/travisvn/openai-edge-tts.git
   cd openai-edge-tts
   

2. 设置Python虚拟环境：

   • 对于macOS/Linux：

     python3 -m venv venv
     source venv/bin/activate
     

   • 对于Windows：

     python -m venv venv
     venv\Scripts\activate
     

3. 安装依赖：

   pip install -r requirements.txt
   

4. 配置环境变量，创建.env文件并设置变量，与使用Docker时相同。

5. 启动服务器：

   python app/server.py
   

使用API

安装并配置完毕后，可以通过以下端点使用API：

• POST /v1/audio/speech：将文本转换为语音。

具体的请求参数和使用方法请参考项目文档。

以上就是OpenAI-Compatible Edge-TTS API的详细安装和配置指南，按照以上步骤操作，您应该能够成功安装并运行该项目。

openai-edge-tts Free, high-quality text-to-speech API endpoint to replace OpenAI, Azure, or ElevenLabs 项目地址: https://gitcode.com/gh_mirrors/op/openai-edge-tts