Skip to content

Latest commit

 

History

History
177 lines (138 loc) · 9.54 KB

api.md

File metadata and controls

177 lines (138 loc) · 9.54 KB

API

使用 launch.py 脚本启动 api 服务之后，你可以在 http://localhost:7870/docs 下查看和简单测试 api

所有参数：

参数 类型 默认值 描述
--host str "0.0.0.0" 服务器主机地址
--port int 8000 服务器端口
--reload bool False 启用自动重载功能（用于开发）
--compile bool False 启用模型编译
--lru_size int 64 设置请求缓存池的大小；设置为 0 禁用 lru_cache
--cors_origin str "*" 允许的 CORS 源，使用 * 允许所有源
--no_playground bool False 关闭 playground 入口
--no_docs bool False 关闭 docs 入口
--no_half bool False 使用 f32 全精度推理
--off_tqdm bool False 关闭 tqdm 进度条
--exclude str "" 排除不需要的 api
--device_id str None 指定使用 gpu device_id
--use_cpu str None 当前可选值 "all"

launch.py 脚本启动成功后，你可以在 /docs 下检查 api 是否开启。

下面特殊接口的介绍

OpenAI API: v1/audio/speech

1. 语音合成 API

Endpoint

POST /v1/audio/speech

请求体

参数名 类型 默认值 描述
input string 必填 需要合成的文本
model string "chattts-4w" 模型名称
voice string "female2" 语音类型
response_format string "mp3" 响应音频格式，可选值：mp3, wav, ogg
speed float 1 音频播放速度，范围是 0.1 到 10
seed int 42 随机种子
temperature float 0.3 控制生成的温度参数
top_k int 20 生成文本时考虑的最高概率词的数量
top_p float 0.7 生成文本时的累积概率阈值
style string "" 风格
batch_size int 1 是否开启 batch 合成，小于等于 1 表示不使用 batch 合成（不推荐），范围是 1 到 20
spliter_threshold float 100 开启 batch 合成时，句子分割的阈值，范围是 10 到 1024
eos string "[uv_break]" 句子结束标志
enhance bool false 是否启用增强功能
denoise bool false 是否启用降噪功能

响应

返回一个音频文件，格式根据 response_format 参数确定。

示例

curl http://localhost:7870/v1/audio/speech \
  -H "Authorization: Bearer anything_your_wanna" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "chattts-4w",
    "input": "Today is a wonderful day to build something people love! [lbreak]",
    "voice": "female2",
    "style": "chat"
  }' \
  --output speech.mp3

也可以使用 openai 库调用，具体可以看 openai 官方文档

Google API: /v1/text:synthesize

Endpoint

POST /v1/text:synthesize

Description

This endpoint synthesizes speech from text or SSML input using the Google Text-to-Speech API. It accepts various configuration parameters to customize the speech synthesis process. The API is designed to be compatible with Google's API while supporting additional parameters specific to this system.

Request Body

Field Type Description
input SynthesisInput Contains either text or ssml to be synthesized.
voice VoiceSelectionParams Specifies the voice parameters, including language code, speaker name, style, and other TTS options.
audioConfig AudioConfig Specifies the audio configuration, such as encoding format, speaking rate, pitch, and volume gain.
enhancerConfig EnhancerConfig (Optional) Additional configuration for audio enhancement.

SynthesisInput

Field Type Description
text str The text input to be synthesized.
ssml str The SSML input to be synthesized.

VoiceSelectionParams

Field Type Description
languageCode str The language code for the voice (default: "ZH-CN").
name str The name of the voice (default: "female2").
style str The style of the voice (default: "").
temperature float The temperature for the TTS model (default: 0.3).
topP float The topP value for the TTS model (default: 0.7).
topK int The topK value for the TTS model (default: 20).
seed int The seed value for inference (default: 42).
eos str The end-of-sentence marker (default: "[uv_break]").

AudioConfig

Field Type Description
audioEncoding AudioFormat The audio encoding format (default: AudioFormat.mp3).
speakingRate float The speaking rate (default: 1).
pitch float The pitch (default: 0).
volumeGainDb float The volume gain in dB (default: 0).
sampleRateHertz int The sample rate in Hertz (default: 24000).
batchSize int The batch size for inference (default: 4).
spliterThreshold int The splitter threshold for text splitting (default: 100).

EnhancerConfig

Field Type Description
... ... ...

Response

Field Type Description
audioContent str The base64-encoded audio content of the synthesis.

Example CURL Request

curl -X POST "http://localhost:7870/v1/text:synthesize" \
    -H "Content-Type: application/json" \
    -d '{
        "input": {
            "text": "Hello, this is a test."
        },
        "voice": {
            "languageCode": "ZH-CN",
            "name": "female2",
            "style": "",
            "temperature": 0.3,
            "topP": 0.7,
            "topK": 20,
            "seed": 42,
            "eos": "[uv_break]"
        },
        "audioConfig": {
            "audioEncoding": "mp3",
            "speakingRate": 1,
            "pitch": 0,
            "volumeGainDb": 0,
            "sampleRateHertz": 24000,
            "batchSize": 4,
            "spliterThreshold": 100
        },
        "enhancerConfig": null
    }'

playground

启动 api 服务之后，在 /playground 下有一个非 gradio 的调试页面用于接口测试

playground

如果不需要此页面，启动服务的时候加上 --no_playground 即可