创建异步语音合成任务
创建异步长文本语音合成任务,支持直接传入文本或文本文件进行合成。
POST/v1/audio/speech/tasks
授权
Authorizationstringheader必填
HTTP: Bearer Auth
- Security Scheme Type: http
- HTTP Authorization Scheme: Bearer API_key,用于验证账户信息,可在 按量计费&资源包>API Key 管理 中查看。
请求头
Content-Typeenum<string>默认值:application/json必填
请求体的媒体类型,请设置为application/json以确保请求数据格式正确。
可用选项:application/json
请求体application/json
modelstring必填
模型编码,可选值:u2-tts, u2-tts-clone, u2-tts-design
textstring
待合成音频的文本,model为u2-tts时,最长 5 万字符,model为u2-tts-clone或u2-tts-design时,最长 2 万字符。与 text_file_id 二选一必填
text_file_idlong
待合成音频的文本文件 ID(txt),model为u2-tts时,最长 5 万字符,model为u2-tts-clone或u2-tts-design时,最长 2 万字符。与 text 二选一必填
voice_settingobject必填
音色基础设置
voice_setting.voice_idstring
系统/克隆/设计音色 ID,可通过查询可用音色 API 获取
voice_setting.speedinteger
语速范围 [0, 100],默认 50。
具体支持详情参见音色参数支持说明。
voice_setting.volumeinteger
音量范围 [0, 100],默认 50。
具体支持详情参见音色参数支持说明。
voice_setting.pitchinteger
音高范围 [0, 100],默认 50。
具体支持详情参见音色参数支持说明。
voice_setting.brightinteger
亮度范围 [50, 100],默认 50。
具体支持详情参见音色参数支持说明。
voice_setting.emotionstring
发音情绪,可选值:happy, angry, depressed, whisper, loudly, neutral,分别对应 6 种情绪:高兴,愤怒,沮丧,低语,大声,中性。目前仅 cn_male_chenyu 发音人,且语种为中文、方言为默认时支持。
voice_setting.languagestring
发音语种,可选值:zh, ja, ko, th, vi, id, ms, my, lo, km, tl, en。
不同音色支持的语种如下:
- `cn_female_shasha`:`zh`(中文)、`ja`(日语)、`ko`(韩语)、`th`(泰语)、`vi`(越南语)、`id`(印尼语)、`km`(柬埔寨语)
- `cn_female_jiajia`:`zh`(中文)、`id`(印尼语)、`ms`(马来语)、`my`(缅甸语)、`lo`(老挝语)
- `cn_male_chenyu`:`zh`(中文)、`tl`(菲律宾语)
- `en_male_johnny`、`en_female_jane`:`en`(英语)
- 其余系统音色:`zh`(中文)
voice_setting.dialectstring
发音方言,可选值:yueyu, sichuan。
目前仅 `cn_male_chenyu` 音色支持以下两种方言:
- `yueyu`(粤语)
- `sichuan`(四川话)
audio_settingobject
音频输出设置
audio_setting.audio_sample_rateinteger
采样率,枚举 [8000, 16000, 24000, 32000],默认 32000
audio_setting.formatstring
输出格式,枚举 [mp3, pcm],默认 mp3
audio_setting.channelinteger
声道数,枚举 [1]
pronunciation_dictobject
自定义发音规则
pronunciation_dict.tonestring[ ]
发音/注音替换规则,示例:["水泊梁山/水泊<py>po1</py>梁山"]。
具体标签说明与支持详情参见自定义发音规则说明。
响应体结构
task_idstring
当前异步合成任务的唯一标识 ID
file_idlong
任务创建成功返回的音频文件 ID
usage_charactersinteger
消耗的字符数
base_respobject
base_resp.status_codeinteger
请求状态码,0 = 正常
base_resp.status_msgstring
状态描述,success 表示成功
音色参数支持说明
不同音色在指定语种、方言下,对 speed、volume、pitch、bright 的支持情况如下。
| 音色 ID (Voice ID) | 语种 (language) | 方言 (dialect) | speed | volume | pitch | bright |
|---|---|---|---|---|---|---|
| cn_female_xiaodi_warm | zh | 默认 | ✓ | ✓ | ✓ | ✓ |
| cn_male_chenyu | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_male_chenyu | zh | yueyu | ✓ | ✓ | ✓ | ✓ |
| cn_male_chenyu | zh | sichuan | ✓ | ✓ | ✓ | ✓ |
| cn_male_chenyu | tl | 默认 | ✗ | ✗ | ✗ | ✗ |
| en_male_johnny | en | 默认 | ✓ | ✓ | ✓ | ✓ |
| en_female_jane | en | 默认 | ✓ | ✓ | ✓ | ✓ |
| cn_male_chenyu_robot | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_male_chenyu_elderly | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_male_chenyu_steady | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_male_chenyu_fluent | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_female_shasha | zh, ja, ko, th, vi, id | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_female_shasha | km | 默认 | ✗ | ✗ | ✗ | ✗ |
| cn_female_jiajia | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_female_jiajia | id, ms, my, lo | 默认 | ✗ | ✗ | ✗ | ✗ |
| cn_female_ruolin | zh | 默认 | ✗ | ✓ | ✓ | ✓ |
| cn_male_jingming | zh | 默认 | ✗ | ✗ | ✗ | ✗ |
| cn_female_shasha_intellectual | zh | 默认 | ✗ | ✗ | ✗ | ✗ |
| cn_female_jiajia_intellectual | zh | 默认 | ✗ | ✗ | ✗ | ✗ |
自定义发音规则说明
可通过以下标签控制读音与断句。不同音色支持的标签不同,详见下方支持情况。
| 类别 | 标签 | 标注作用 | 文本标注 | 播报效果 |
|---|---|---|---|---|
| 数字类 | <value> | 使数字串按照数值的方式发音 | 这是第<value>110</value>会议室 | 这是第一百一十会议室 |
| <code> | 使数字串按照编码的方式发音(“1”读作“一”) | 这是第<code>110</code>会议室 | 这是一一零会议室 | |
| <tel> | 使数字串按照电话号码的方式发音(“1”读作“幺”) | 会议室分机号为<tel>110</tel> | 会议室分机号为幺幺零 | |
| 注音类 | <py> | 使引擎按照指定的读音播报汉字 | 搜索结果为<py>wei2</py>空<py>kong1</py> | 搜索结果为(wei2)空(kong1) |
| <pname> | 使引擎正确播报姓名中的多音字姓氏 | 播放<pname>单田芳</pname>的评书 | 播放单(shan4)田芳的评书 | |
| 断句类 | <word> | 按标注进行分词,用于解决分词错误。例如区分(乒乓球)(拍卖)(完了)与(乒乓)(球拍)(卖完了) | <word>乒乓</word><word>球拍</word><word>卖完了</word> | (乒乓)(球拍)(卖完了) |
| <phrase> | 按标注进行断句(停顿长于 word),用于解决断句错误。例如区分(爸爸亲了我妈妈)(也亲了我)与(爸爸亲了我)(妈妈也亲了我) | <phrase>爸爸亲了我</phrase><phrase>妈妈也亲了我</phrase> | (爸爸亲了我) (妈妈也亲了我) | |
| 英文类 | <letter> | 将标注的英文按字母逐个播报 | 世界卫生组织的英文缩写<letter>WHO</letter> | 世界卫生组织的英文缩写是(W)(H)(O) |
| 其他 | <mute> | 在句中手动增加指定时长的停顿(单位:毫秒) | 请您再说一遍<mute>300</mute>或说取消 | 请您再说一遍(停顿300ms)或说取消 |
| <sub> | 使用 alias 属性中的内容替换标注文本进行播报 | 气压的测量单位是<sub alias="毫米汞柱">mmHg</sub> | 气压的测量单位是毫米汞柱 |
标签支持情况
| 音色 ID (Voice ID) | 语种 (language) | 方言 (dialect) | 支持标签 |
|---|---|---|---|
| cn_female_xiaodi_warm | zh | 默认 | 全部支持 |
| cn_male_chenyu | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_male_chenyu | zh | yueyu | 全部支持 |
| cn_male_chenyu | zh | sichuan | 全部支持 |
| cn_male_chenyu | tl | 默认 | 不支持 |
| en_male_johnny | en | 默认 | 全部支持 |
| en_female_jane | en | 默认 | 全部支持 |
| cn_male_chenyu_robot | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_male_chenyu_elderly | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_male_chenyu_steady | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_male_chenyu_fluent | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_female_shasha | zh, ja, ko, th, vi, id | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_female_shasha | km | 默认 | 不支持 |
| cn_female_jiajia | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_female_jiajia | id, ms, my, lo | 默认 | 不支持 |
| cn_female_ruolin | zh | 默认 | 部分支持(value、code、tel、py、letter、sub、word) |
| cn_male_jingming | zh | 默认 | 不支持 |
| cn_female_shasha_intellectual | zh | 默认 | 不支持 |
| cn_female_jiajia_intellectual | zh | 默认 | 不支持 |