{"repo": "artrajz/vits-simple-api", "files": {"README_zh.md": {"c3d179ffabff711e6697c6eb16298ac66a250406": {"t": 1785596177.0922985, "n": 21327, "h": "42d4eed89c11af81", "c": "
\n

vits-simple-api

\n\t
Simply call the vits api
\n
\n
\n

\n \n \t\n \n \n

\n English|中文文档\n
\n
\n\n\n\n\n\n# Feature\n\n- [x] VITS语音合成，语音转换\n- [x] HuBert-soft VITS模型\n- [x] W2V2 VITS / [emotional-vits](https://github.com/innnky/emotional-vits)维度情感模型\n- [x] [vits_chinese](https://github.com/PlayVoice/vits_chinese)\n- [x] [Bert-VITS2](https://github.com/Stardust-minus/Bert-VITS2)\n- [x] [GPT-SoVITS](https://github.com/RVC-Boss/GPT-SoVITS)\n- [x] 加载多模型\n- [x] 自动识别语言并处理，根据模型的cleaner设置语言类型识别的范围，支持自定义语言类型范围\n- [x] 自定义默认参数\n- [x] 长文本批处理\n- [x] GPU加速推理\n- [x] SSML语音合成标记语言（完善中...）\n\n\n## 在线demo\n\n[![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Artrajz/vits-simple-api) 感谢hugging face喵\n\n[Colab Notebook](https://colab.research.google.com/drive/1uBkMy0UjLE3C1zvxZ7NPPc3K74v4B6zw)\n\n注意不同的id支持的语言可能有所不同。[speakers](https://artrajz-vits-simple-api.hf.space/voice/speakers)\n\n\n- `https://artrajz-vits-simple-api.hf.space/voice/vits?text=你好,こんにちは&id=164`\n- `https://artrajz-vits-simple-api.hf.space/voice/vits?text=我觉得1%2B1≠3&id=164&lang=zh`（get中一些字符需要转义不然会被过滤掉）\n- `https://artrajz-vits-simple-api.hf.space/voice/vits?text=Difficult the first time, easy the second.&id=4`\n- 激动：`https://artrajz-vits-simple-api.hf.space/voice/w2v2-vits?text=こんにちは&id=3&emotion=111`\n- 小声：`https://artrajz-vits-simple-api.hf.space/voice/w2v2-vits?text=こんにちは&id=3&emotion=2077`\n\nhttps://user-images.githubusercontent.com/73542220/237995061-c1f25b4e-dd86-438a-9363-4bb1fe65b425.mov\n\n# 部署\n\n有两种部署方式可供选择。不论你选择哪一种，完成部署后都需要导入模型才能使用。\n\n## Docker部署（Linux推荐）\n\n### 步骤1: 镜像拉取\n\n运行以下命令以拉取 Docker 镜像，根据脚本中的提示选择需要下载的必要文件和拉取镜像：\n\n```bash\nbash -c \"$(wget -O- https://raw.githubusercontent.com/Artrajz/vits-simple-api/main/vits-simple-api-installer-latest.sh)\"\n```\n\n项目配置文件以及模型文件夹的默认路径为`/usr/local/vits-simple-api/`\n\n### 步骤2: 启动\n\n运行以下命令启动容器：\n\n```bash\ndocker-compose up -d\n```\n\n### 镜像更新\n\n运行以下命令更新镜像：\n\n```bash\ndocker-compose pull\n```\n\n重新启动容器：\n\n```bash\ndocker-compose up -d\n```\n\n## 虚拟环境部署\n\n### 步骤1: 克隆项目\n\n使用以下命令克隆项目仓库：\n\n```bash\ngit clone https://github.com/Artrajz/vits-simple-api.git\n```\n\n### 步骤2: 下载 Python 依赖\n\n推荐使用 Python 3.10版本的虚拟环境。运行以下命令安装项目所需的 Python 依赖：\n\n如果遇到某些无法安装的依赖，请看下面的常见问题。\n\n```bash\npip install -r requirements.txt\n```\n\n### 步骤3: 启动\n\n运行以下命令启动程序：\n\n```bash\npython app.py\n```\n\n## Windows快速部署包\n\n### 步骤1：下载并解压部署包\n\n进入[releases页面](https://github.com/Artrajz/vits-simple-api/releases)下载并解压最新的部署包\n\n出于压缩体积考虑（以及Github release限制单个文件2GB大小），有部分可选的依赖模型没有被内置于部署包中，这些模型通常会在加载对应声音模型时被程序**自动下载**（如果载入的模型需要的话）\n\n假如程序没有自动下载成功需要手动下载对应依赖模型，或者您发现成功载入的声音模型为空，请阅读下面的**故障排除——成功载入的模型为空**部分\n\n### 步骤2：启动\n\n运行start.bat启动程序\n\n## 云端镜像一键部署\n\n已在优云智算平台部署此项目镜像，无需配置，开箱即用，注册免费体验5小时4090或10小时3080TI [点击跳转](https://www.compshare.cn/images/jZtOlBLHJi5K?referral_code=JqaheomBz8wCDWeUkpDSDF&ytag=GPU_yy_gh_vits)\n\n## 模型加载\n\n### 步骤1: 下载 VITS 模型\n\n将 VITS 模型文件下载并放入 `data/models`文件夹。\n\n### 步骤2: 加载模型\n\n#### 自动加载模型\n\nv0.6.6版本之后默认会**自动加载**`data/models`文件夹下的所有模型，方便新手使用（如果您是第一次使用并且没有任何额外的特殊需要，您可以不用了解如何手动加载模型）。\n\n#### 手动加载模型\n\n首次启动之后会生成一个config.yaml配置文件，需要将`tts_config.auto_load`改为`false`以启用手动加载模式。\n\n可以修改配置文件中的`tts_model_config.tts_modes`或者在浏览器中进入管理员后台进行修改。\n\n**注意：v0.6.6版本之后已修改模型读取路径，请重新按照以下步骤配置模型路径！**\n\n路径可填绝对路径或相对路径，相对路径则是从项目根目录中的`data/models`文件夹开始。\n\n比如`data/models`文件夹中有如下文件\n\n```\n├─model1\n│ │─G_1000.pth\n│ └─config.json\n└─model2\n │─G_1000.pth\n └─config.json\n```\n\n填写\n\n```yaml\ntts_model_config:\n models_dir: models\n auto_load: false\n tts_models:\n - config_path: model1/config.json\n vits_path: model1/G_1000.pth\n - config_path: model2/config.json\n vits_path: model2/G_1000.pth\n\t# GPT-SoVITS则为\n - vits_path: gpt_sovits1/model1_e8_s11536.pth\n t2s_path: gpt_sovits1/model1-e15.ckpt\n - vits_path: gpt_sovits2/model2_e8_s11536.pth\n t2s_path: gpt_sovits2/model2-e15.ckpt\n\n```\n\n在管理员后台加载模型比较方便，但如果想加载`data/models`文件夹之外的模型，则只能通过修改config.yaml配置文件来加载，方法是直接填写绝对路径。\n\n绝对路径填写：\n\n```yaml\ntts_model_config:\n models_dir: models\n auto_load: false\n tts_models:\n - config_path: D://model3/config.json\n vits_path: D://model3/G_1000.pth\n```\n\n- `models_dir`是相对于data目录下的模型文件夹，默认为models，`auto_load`为true时将会加载`models_dir`目录下的所有模型。\n\n#### 其他模型\n\nbert模型以及情感模型下载之后放在`data/bert`文件夹和`data/emotional`文件夹中，找到对应名字放入即可。\n\n# GPU 加速\n\n## windows\n\n### 安装CUDA\n\n查看显卡最高支持CUDA的版本\n\n```\nnvidia-smi\n```\n\n以CUDA11.7为例，[官网](https://developer.nvidia.com/cuda-11-7-0-download-archive?target_os=Windows&target_arch=x86_64&target_version=10&target_type=exe_local)\n\n### 安装GPU版pytorch\n\nhttps://pytorch.org/\n\n```\npip install torch --index-url https://download.pytorch.org/whl/cu118\n```\n\n## Linux\n\n安装过程类似，可以查阅网上的安装资料。也可以直接使用docker部署脚本中的gpu版本。\n\n# WebUI\n\n## 推理前端 \n\nhttp://127.0.0.1:23456\n\n*在默认端口为23456的情况下，端口可修改\n\n## 管理员后台\n\n默认为http://127.0.0.1:23456/admin\n\n**初始账号密码在初次启动后，在config.yaml中搜索admin可找到。**\n\n# 功能选项说明\n\n## 关闭管理员后台\n\n由于管理员后台可以对模型进行加载和卸载操作，虽然有登录验证的保障，为了绝对安全，当对公网开放时，可以在`config.yaml`中关闭管理员后台：\n\n```yaml\n'IS_ADMIN_ENABLED': !!bool 'false'\n```\n\n## Bert-VITS2配置使用语言/Bert模型\n\n在Bert-VITS2 v2.0以后，一个模型需要加载三个不同语言的Bert模型。如果只需要使用其中一或两种语言，可以在模型的config.json的data中，添加`lang`参数，值为`[\"zh\"]`，表示该模型只使用中文，同时也只会加载中文的Bert模型。值为`[\"zh\",\"ja\"]`表示只使用中日双语，同时也只会加载中文和日文的Bert模型。以此类推。\n\n示例：\n\n```json\n\"data\": {\n \"lang\": [\"zh\",\"ja\"],\n \"training_files\": \"filelists/train.list\",\n \"validation_files\": \"filelists/val.list\",\n \"max_wav_value\": 32768.0,\n ...\n```\n\n## 自定义中文多音字词典\n\n如果遇到多音字发音不正确，可以尝试用这种办法解决。\n\n在data目录创建并打开phrases_dict.txt添加多音字词。\n\n```python\n{\n\"一骑当千\": [[\"yí\"], [\"jì\"], [\"dāng\"], [\"qiān\"]],\n}\n```\n\n## GPT-SoVITS参考音频预设\n\n在config.yaml中找到gpt_sovits的配置，在presets下添加预设，预设可添加多个，其中key作为预设名称，如下有两个默认的预设default和default2：\n\n```\ngpt_sovits_config:\n hz: 50\n is_half: false\n id: 0\n lang: auto\n format: wav\n segment_size: 50\n presets:\n default:\n refer_wav_path: null\n prompt_text: null\n prompt_lang: auto\n default2:\n refer_wav_path: null\n prompt_text: null\n prompt_lang: auto\n```\n\n## 阅读API\n\n在[开源阅读](https://gedoor.github.io/)中测试\n\n可使用多种模型朗读，包括VITS，Bert-VITS2，GPT-SoVITS，`in`开头的参数配置的是对话即引号中的文本的说话人，`nr`开头的参数配置的是旁白。\n\n使用GPT-SoVITS需要提前在`config.yaml`配置好`presets`里的参考音频，并修改下方url中的preset\n\nurl中的IP可在API启动后找到，一般使用192.168开头的局域网IP。\n\n修改好后，选择朗读引擎-添加朗读引擎-粘贴源，并启用该朗读引擎。\n\n```js\n{\n \"concurrentRate\": \"1\",\n \"contentType\": \"audio/wav\",\n \"enabledCookieJar\": false,\n \"header\": \"\",\n \"id\": 1709643305070,\n \"lastUpdateTime\": 1709821070082,\n \"loginCheckJs\": \"\",\n \"loginUi\": \"\",\n \"loginUrl\": \"\",\n \"name\": \"vits-simple-api\",\n \"url\": \"http://192.168.xxx.xxx:23456/voice/reading?text={{java.encodeURI(speakText)}}&in_model_type=GPT-SOVITS&in_id=0&in_preset=default&nr_model_type=BERT-VITS2&nr_id=0&nr_preset=default&format=wav&lang=zh\"\n}\n```\n\n\n\n# 常见问题\n\n## Bert-VITS2版本兼容\n\n修改Bert-VITS2模型的config.json，加入版本号参数`\"version\": \"x.x.x\"`，比如模型版本为1.0.1时，配置文件应该写成：\n\n```\n{\n \"version\": \"1.0.1\",\n \"train\": {\n \"log_interval\": 10,\n \"eval_interval\": 100,\n \"seed\": 52,\n ...\n```\n\n需要注意的是，中文特化版的版本号应改为`extra`或`zh-clap`，特化修复版的版本号为`2.4`或`extra-fix`。\n\n## 故障排除——成功载入的模型为空\n首先，请检查您的程序目录是否为**纯英文路径**（不能含有任何的中文或者特殊字符），否则将会碰到程序不报错也无法载入模型的情况\n\n其次，请核对您的模型位置是否放置正确(可参考**手动加载模型**部分)\n\n您的模型不应该直接放置在`data/models`，而是应该放置在models目录下面的文件夹中（这个文件夹可以是没有特殊字符的任意名称），每个声音模型对应一个目录\n\n最后，请检查log中是否有类似下载失败的信息，您可以参考下文手动放置依赖模型\n\n### 手动放置依赖模型\n\n下载 https://hf-mirror.com/TencentGameMate/chinese-hubert-base/resolve/main/pytorch_model.bin 放置于 'data\\hubert\\chinese_hubert_base'\n\n下载 https://hf-mirror.com/hfl/chinese-roberta-wwm-ext-large/resolve/main/pytorch_model.bin 放置于 'data\\bert\\chinese-roberta-wwm-ext-large'\n\n下载 https://openi.pcl.ac.cn/Stardust_minus/Bert-VITS2/modelmanage/model_filelist_tmpl?name=G2PWModel-v2-onnx 放置于 'data\\G2PWModel'\n\n若您不想从启智平台下载（大文件无法直接浏览器上获取），则可以从这里 https://huggingface.co/restsun2028/B2ZHTH/blob/b0a8cc2c69c6d1962c679ea2887080a0a86e6bbf/g2pW/g2pW.onnx 获取到 'g2pW.onnx'\n\n# API\n\n## GET\n\n#### speakers list \n\n- GET http://127.0.0.1:23456/voice/speakers\n\n 返回id对应角色的映射表\n\n#### voice vits\n\n- GET http://127.0.0.1:23456/voice/vits?text=text\n\n 其他参数不指定时均为默认值\n\n- GET http://127.0.0.1:23456/voice/vits?text=[ZH]text[ZH][JA]text[JA]&lang=mix\n\n lang=mix时文本要标注\n\n- GET http://127.0.0.1:23456/voice/vits?text=text&id=142&format=wav&lang=zh&length=1.4\n\n 文本为text，角色id为142，音频格式为wav，文本语言为zh，语音长度为1.4，其余参数默认\n\n#### check\n\n- GET http://127.0.0.1:23456/voice/check?id=0&model=vits\n\n## POST\n\n- 见`api_test.py`\n\n\n\n## API KEY\n\n在config.yaml中设置`api_key_enabled: true`以启用。\n\n启用后，GET请求中使用需要增加参数api_key，POST请求中使用需要在header中添加参数`X-API-KEY`。\n\n# Parameter\n\n## VITS语音合成\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| ------------- | ------------ | ------- | -------------------- | ----- | ------------------------------------------------------------ |\n| 合成文本 | text | true | | str | 需要合成语音的文本。 |\n| 角色id | id | false | 从`config.yaml`中获取 | int | 即说话人id。 |\n| 音频格式 | format | false | 从`config.yaml`中获取 | str | 支持wav,ogg,silk,mp3,flac |\n| 文本语言 | lang | false | 从`config.yaml`中获取 | str | auto为自动识别语言模式，也是默认模式。lang=mix时，文本应该用[ZH] 或 [JA] 包裹。方言无法自动识别。 |\n| 语音长度/语速 | length | false | 从`config.yaml`中获取 | float | 调节语音长度，相当于调节语速，该数值越大语速越慢。 |\n| 噪声 | noise | false | 从`config.yaml`中获取 | float | 样本噪声，控制合成的随机性。 |\n| sdp噪声 | noisew | false | 从`config.yaml`中获取 | float | 随机时长预测器噪声，控制音素发音长度。 |\n| 分段阈值 | segment_size | false | 从`config.yaml`中获取 | int | 按标点符号分段，加起来大于segment_size时为一段文本。segment_size<=0表示不分段。 |\n| 流式响应 | streaming | false | false | bool | 流式合成语音，更快的首包响应。 |\n\n## VITS 语音转换\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| ---------- | ----------- | ------- | ------- | ---- | ---------------------- |\n| 上传音频 | upload | true | | file | wav or ogg |\n| 源角色id | original_id | true | | int | 上传文件所使用的角色id |\n| 目标角色id | target_id | true | | int | 要转换的目标角色id |\n\n## HuBert-VITS 语音转换\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| ------------- | --------- | ------- | ------- | ----- | ------------------------------------------------ |\n| 上传音频 | upload | true | | file | 需要转换说话人的音频文件。 |\n| 目标角色id | id | true | | int | 目标说话人id。 |\n| 音频格式 | format | true | | str | wav,ogg,silk |\n| 语音长度/语速 | length | true | | float | 调节语音长度，相当于调节语速，该数值越大语速越慢 |\n| 噪声 | noise | true | | float | 样本噪声，控制合成的随机性。 |\n| sdp噪声 | noisew | true | | float | 随机时长预测器噪声，控制音素发音长度。 |\n\n## W2V2-VITS\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| ------------- | ------------ | ------- | -------------------- | ----- | ------------------------------------------------------------ |\n| 合成文本 | text | true | | str | 需要合成语音的文本。 |\n| 角色id | id | false | 从`config.yaml`中获取 | int | 即说话人id。 |\n| 音频格式 | format | false | 从`config.yaml`中获取 | str | 支持wav,ogg,silk,mp3,flac |\n| 文本语言 | lang | false | 从`config.yaml`中获取 | str | auto为自动识别语言模式，也是默认模式。lang=mix时，文本应该用[ZH] 或 [JA] 包裹。方言无法自动识别。 |\n| 语音长度/语速 | length | false | 从`config.yaml`中获取 | float | 调节语音长度，相当于调节语速，该数值越大语速越慢 |\n| 噪声 | noise | false | 从`config.yaml`中获取 | float | 样本噪声，控制合成的随机性。 |\n| sdp噪声 | noisew | false | 从`config.yaml`中获取 | float | 随机时长预测器噪声，控制音素发音长度。 |\n| 分段阈值 | segment_size | false | 从`config.yaml`中获取 | int | 按标点符号分段，加起来大于segment_size时为一段文本。segment_size<=0表示不分段。 |\n| 维度情感 | emotion | false | 0 | int | 范围取决于npy情感参考文件，如[innnky](https://huggingface.co/spaces/innnky/nene-emotion/tree/main)的all_emotions.npy模型范围是0-5457 |\n\n## Dimensional emotion\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| -------- | --------- | ------- | ------- | ---- | ----------------------------- |\n| 上传音频 | upload | true | | file | 返回存储维度情感向量的npy文件 |\n\n## Bert-VITS2语音合成\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| -------------- | --------------- | ------- | -------------------- | ----- | ------------------------------------------------------------ |\n| 合成文本 | text | true | | str | 需要合成语音的文本。 |\n| 角色id | id | false | 从`config.yaml`中获取 | int | 即说话人id。 |\n| 音频格式 | format | false | 从`config.yaml`中获取 | str | 支持wav,ogg,silk,mp3,flac |\n| 文本语言 | lang | false | 从`config.yaml`中获取 | str | auto为自动识别语言模式，也是默认模式，但目前只支持识别整段文本的语言，无法细分到每个句子。其余可选语言zh和ja。 |\n| 语音长度/语速 | length | false | 从`config.yaml`中获取 | float | 调节语音长度，相当于调节语速，该数值越大语速越慢。 |\n| 噪声 | noise | false | 从`config.yaml`中获取 | float | 样本噪声，控制合成的随机性。 |\n| sdp噪声 | noisew | false | 从`config.yaml`中获取 | float | 随机时长预测器噪声，控制音素发音长度。 |\n| 分段阈值 | segment_size | false | 从`config.yaml`中获取 | int | 按标点符号分段，加起来大于segment_size时为一段文本。segment_size<=0表示不分段。 |\n| SDP/DP混合比 | sdp_ratio | false | 从`config.yaml`中获取 | int | SDP在合成时的占比，理论上此比率越高，合成的语音语调方差越大。 |\n| 情感控制 | emotion | false | 从`config.yaml`中获取 | int | Bert-VITS2 v2.1可用，范围为0-9 |\n| 情感参考音频 | reference_audio | false | None | | Bert-VITS2 v2.1 使用参考音频来控制合成音频的情感 |\n| 文本提示词 | text_prompt | false | 从`config.yaml`中获取 | str | Bert-VITS2 v2.2 文本提示词，用于控制情感 |\n| 文本提示词 | style_text | false | 从`config.yaml`中获取 | str | Bert-VITS2 v2.3 文本提示词，用于控制情感 |\n| 文本提示词权重 | style_weight | false | 从`config.yaml`中获取 | float | Bert-VITS2 v2.3 文本提示词，用于提示词权重 |\n| 流式响应 | streaming | false | false | bool | 流式合成语音，更快的首包响应。 |\n\n## GPT-SoVITS语音合成\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| ------------ | --------------- | ------- | --------------------- | ----- | ------------------------------------------------------------ |\n| 合成文本 | text | true | | str | 需要合成语音的文本。 |\n| 角色id | id | false | 从`config.yaml`中获取 | int | 即说话人id。在GPT-SoVITS中，每一个模型作为一个角色id，音色通过参考音频预设来切换。 |\n| 音频格式 | format | false | 从`config.yaml`中获取 | str | 支持wav,ogg,silk,mp3,flac |\n| 文本语言 | lang | false | 从`config.yaml`中获取 | str | auto为自动识别语言模式，也是默认模式，但目前只支持识别整段文本的语言，无法细分到每个句子。 |\n| 参考音频 | reference_audio | false | None | | 参考音频是必须的，但是可以被预设代替 |\n| 参考音频文本 | prompt_text | false | 从`config.yaml`中获取 | float | 需要和参考音频实际文本保持一致。 |\n| 参考音频语言 | prompt_lang | false | 从`config.yaml`中获取 | str | 默认为auto，自动识别文本语言。如果识别失败则手动填写，中文就是zh，日文是ja，英文是en。 |\n| 参考音频预设 | preset | false | default | str | 通过提前设置好的预设代替参考音频，可设置多个预设。 |\n\n\n## SSML语音合成标记语言\n\n目前支持的元素与属性\n\n`speak`元素\n\n| Attribute | Description | Is must |\n| ------------ | ------------------------------------------------------------ | ------- |\n| id | 默认值从`config.yaml`中读取 | false |\n| lang | 默认值从`config.yaml`中读取 | false |\n| length | 默认值从`config.yaml`中读取 | false |\n| noise | 默认值从`config.yaml`中读取 | false |\n| noisew | 默认值从`config.yaml`中读取 | false |\n| segment_size | 按标点符号分段，加起来大于segment_size时为一段文本。segment_size<=0表示不分段，这里默认为0。 | false |\n| model_type | 默认为VITS，可选W2V2-VITS，BERT-VITS2 | false |\n| emotion | 只有用W2V2-VITS时`emotion`才会生效，范围取决于npy情感参考文件 | false |\n| sdp_ratio | 只有用BERT-VITS2时`sdp_ratio`才会生效 | false |\n\n`voice`元素\n\n优先级大于`speak`\n\n| Attribute | Description | Is must |\n| ------------ | ------------------------------------------------------------ | ------- |\n| id | 默认值从`config.yaml`中读取 | false |\n| lang | 默认值从`config.yaml`中读取 | false |\n| length | 默认值从`config.yaml`中读取 | false |\n| noise | 默认值从`config.yaml`中读取 | false |\n| noisew | 默认值从`config.yaml`中读取 | false |\n| segment_size | 按标点符号分段，加起来大于segment_size时为一段文本。segment_size<=0表示不分段，这里默认为0。 | false |\n| model_type | 默认为VITS，可选W2V2-VITS，BERT-VITS2 | false |\n| emotion | 只有用W2V2-VITS时`emotion`才会生效，范围取决于npy情感参考文件 | false |\n| sdp_ratio | 只有用BERT-VITS2时`sdp_ratio`才会生效 | false |\n\n`break`元素\n\n| Attribute | Description | Is must |\n| --------- | ------------------------------------------------------------ | ------- |\n| strength | x-weak,weak,medium（默认值）,strong,x-strong | false |\n| time | 暂停的绝对持续时间，以秒为单位（例如 `2s`）或以毫秒为单位（例如 `500ms`）。 有效值的范围为 0 到 5000 毫秒。 如果设置的值大于支持的最大值，则服务将使用 `5000ms`。 如果设置了 `time` 属性，则会忽略 `strength` 属性。 | false |\n\n| Strength | Relative Duration |\n| :------- | :---------------- |\n| x-weak | 250 毫秒 |\n| weak | 500 毫秒 |\n| Medium | 750 毫秒 |\n| Strong | 1000 毫秒 |\n| x-strong | 1250 毫秒 |\n\n## 阅读\n\n| Name | Parameter | Is must | Default | Type | Instruction |\n| -------------------- | ------------- | ------- | --------------------- | ---- | ------------------------------------------------------------ |\n| 合成文本 | text | true | | str | 需要合成语音的文本。 |\n| 对话角色模型类型 | in_model_type | false | 从`config.yaml`中获取 | str | |\n| 对话角色id | in_id | false | 从`config.yaml`中获取 | int | |\n| 对话角色参考音频预设 | in_preset | false | default | str | 通过提前设置好的预设代替参考音频，可设置多个预设。 |\n| 旁白角色模型类型 | nr_model_type | false | 从`config.yaml`中获取 | str | |\n| 旁白角色id | nr_id | false | 从`config.yaml`中获取 | int | |\n| 旁白角色参考音频预设 | nr_preset | false | default | str | 通过提前设置好的预设代替参考音频，可设置多个预设。 |\n| 音频格式 | format | false | 从`config.yaml`中获取 | str | 支持wav,ogg,silk,mp3,flac |\n| 文本语言 | lang | false | 从`config.yaml`中获取 | str | auto为自动识别语言模式，也是默认模式，但目前只支持识别整段文本的语言，无法细分到每个句子。 |\n\n模型的其他参数将使用config.yaml文件中对应模型的默认参数。\n\n\n\n## 示例\n\n见`api_test.py`\n\n# 交流平台\n\n现在只有 [Q群](https://qm.qq.com/cgi-bin/qm/qr?k=-1GknIe4uXrkmbDKBGKa1aAUteq40qs_&jump_from=webapi&authKey=x5YYt6Dggs1ZqWxvZqvj3fV8VUnxRyXm5S5Kzntc78+Nv3iXOIawplGip9LWuNR/)\n\n# 鸣谢\n\n- vits:https://github.com/jaywalnut310/vits\n- MoeGoe:https://github.com/CjangCjengh/MoeGoe\n- emotional-vits:https://github.com/innnky/emotional-vits\n- vits-uma-genshin-honkai:https://huggingface.co/spaces/zomehwh/vits-uma-genshin-honkai\n- vits_chinese:https://github.com/PlayVoice/vits_chinese\n- Bert_VITS2:https://github.com/fishaudio/Bert-VITS2\n- GPT-SoVITS:https://github.com/RVC-Boss/GPT-SoVITS\n\n# 感谢所有的贡献者\n\n\n \n"}}}}