CosyVoice 声音复刻 Java SDK 参考(VoiceEnrollmentService)。
通过 DashScope Java SDK 的
创建服务前设置 base URL:
包路径:
从音频创建克隆音色。
返回值:
列出克隆音色,支持前缀过滤和分页。
返回值:
查询指定克隆音色的详细信息。
返回值:
用新音频更新已有克隆音色。
删除克隆音色。
包路径:
VoiceEnrollmentService 类调用 CosyVoice 声音复刻。该 SDK 仅覆盖声音复刻功能,CosyVoice 声音设计以及所有 Qwen 声音复刻/设计请使用 HTTP API。
用户指南:声音复刻。
前提条件
Service URL
创建服务前设置 base URL:
VoiceEnrollmentService 类
包路径:com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService
管理 CosyVoice 克隆音色的完整生命周期(创建、列表、查询、更新、删除)。
构造方法
| 参数 | 类型 | 说明 |
|---|---|---|
| apiKey | String | DashScope API Key。 |
createVoice()
从音频创建克隆音色。
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| targetModel | String | 是 | 克隆音色绑定的语音合成模型。后续合成调用的 model 必须与此一致。 |
| prefix | String | 是 | 音色名称前缀,仅限字母和数字,最长 10 个字符。 |
| url | String | 是 | 用于克隆的音频文件 URL,必须可公开访问。 |
| customParam | VoiceEnrollmentParam | 否 | 可选参数(languageHints、maxPromptAudioLength 等),详见 VoiceEnrollmentParam。 |
Voice 对象,调用 getVoiceId() 获取音色 ID。
listVoice()
列出克隆音色,支持前缀过滤和分页。
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| prefix | String | 否 | 按名称前缀过滤。 |
| pageIndex | int | 否 | 页码,从 0 开始。 |
| pageSize | int | 否 | 每页条数。 |
Voice[] 音色对象数组。
queryVoice()
查询指定克隆音色的详细信息。
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| voiceId | String | 是 | 要查询的音色 ID。 |
Voice 对象,包含状态、目标模型等信息。
updateVoice()
用新音频更新已有克隆音色。
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| voiceId | String | 是 | 要更新的音色 ID。 |
| url | String | 是 | 新的音频文件 URL,必须可公开访问。 |
| customParam | VoiceEnrollmentParam | 否 | 可选参数。 |
deleteVoice()
删除克隆音色。
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| voiceId | String | 是 | 要删除的音色 ID。 |
完整示例
创建音色
列表查询
查询音色详情
更新音色
删除音色
VoiceEnrollmentParam 类
包路径:com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentParam
使用 Builder 模式构造 createVoice() 和 updateVoice() 的可选参数。
| Builder 方法 | 类型 | 说明 |
|---|---|---|
| model(String) | String | 声音复刻模型,固定为 voice-enrollment。 |
| languageHints(List<String>) | List<String> | 音频的语言提示,仅使用第一个元素。默认:["zh"]。 |
| maxPromptAudioLength(Float) | Float | 预处理后的最大音频时长(秒)。范围:[3.0, 30.0]。默认:10.0。 |
| parameter(String, Object) | Object | 设置额外参数,如 parameter("enable_preprocess", false)。 |
enable_preprocess
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
| enable_preprocess | boolean | 否 | 是否启用音频预处理(降噪、增强、音量归一化)。有噪音的音频建议开启,干净音频建议关闭。默认:false。 |