API接口详情

接口说明

def create_voice(self, target_model: str, prefix: str, url: str) -> str:
    '''
    创建音色
    param: target_model 声音复刻所使用的模型，请使用cosyvoice-v2。
    param: prefix 音色自定义前缀，仅允许数字和小写字母，小于十个字符。
    param: url 用于复刻音色的音频文件URL。该URL要求公网可访问。
    return: voice_id
    '''

请求示例

import os
import dashscope
from dashscope.audio.tts_v2 import VoiceEnrollmentService

dashscope.api_key = os.getenv('DASHSCOPE_API_KEY')  # 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
url = "https://your-audio-file-url"  # 请按实际情况进行替换
prefix = 'prefix' # 请按实际情况进行替换
target_model = "cosyvoice-v2"

# 创建语音注册服务实例
service = VoiceEnrollmentService()

# 调用create_voice方法复刻声音，并生成voice_id
# 避免频繁调用 create_voice 方法。每次调用都会创建新音色，每个阿里云主账号最多可复刻 1000 个音色，超额时请删除不用的音色或申请扩容。
voice_id = service.create_voice(target_model=target_model, prefix=prefix, url=url)
print("request id为：", service.get_last_request_id())
print(f"voice id为：{voice_id}")

接口说明

/**
 * 创建音色
 *
 * @param targetModel 声音复刻所使用的模型，请使用cosyvoice-v2。
 * @param prefix 音色自定义前缀，仅允许数字和小写字母，小于十个字符。
 * @param url 用于复刻音色的音频文件URL。该URL要求公网可访问。
 * @return Voice 音色对象
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public Voice createVoice(String targetModel, String prefix, String url) throws NoApiKeyException, InputRequiredException

请求示例

import com.alibaba.dashscope.audio.ttsv2.enrollment.Voice;
import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import static java.lang.System.exit;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
    private static String fileUrl = "https://your-audio-file-url";  // 请按实际情况进行替换
    private static String prefix = "prefix"; // 请按实际情况进行替换
    private static String targetModel = "cosyvoice-v2";

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 创建音色
        Voice myVoice = service.createVoice(targetModel, prefix, fileUrl);
        System.out.println("request id为：" + service.getLastRequestId());
        System.out.println("voice id为：" + myVoice.getVoiceId());
        exit(0);
    }
}

音色状态有三种：

接口说明

def list_voices(self, prefix=None, page_index: int = 0, page_size: int = 10) -> List[dict]:
    '''
    查询已创建的所有音色
    param: prefix 音色前缀，设置为None则返回所有音色
    param: page_index 查询的页索引
    param: page_size 查询页大小
    return: List[dict] 音色列表，包含每个音色的id，创建时间，修改时间，状态。
    '''

请求示例

import os
import dashscope
from dashscope.audio.tts_v2 import VoiceEnrollmentService

dashscope.api_key = os.getenv('DASHSCOPE_API_KEY')  # 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
prefix = 'prefix' # 请按实际情况进行替换

# 创建语音注册服务实例
service = VoiceEnrollmentService()

voices = service.list_voices(prefix=prefix, page_index=0, page_size=10)
print("request id为：", service.get_last_request_id())
print(f"查询到的音色为：{voices}")

响应示例

[
    {
        "gmt_create": "2024-09-13 11:29:41",
        "voice_id": "yourVoiceId",
        "gmt_modified": "2024-09-13 11:29:41",
        "status": "OK"
    },
    {
        "gmt_create": "2024-09-13 13:22:38",
        "voice_id": "yourVoiceId",
        "gmt_modified": "2024-09-13 13:22:38",
        "status": "OK"
    }
]

响应参数

音色状态有三种：

接口说明

/**
 * 查询已创建的所有音色 默认的页索引为0，默认的页大小为10
 *
 * @param prefix 音色自定义前缀，仅允许数字和小写字母，小于十个字符。可以为null。
 * @return Voice[] 音色对象数组
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public Voice[] listVoice(String prefix) throws NoApiKeyException, InputRequiredException 

/**
 * 查询已创建的所有音色
 *
 * @param prefix 音色自定义前缀，仅允许数字和小写字母，小于十个字符。
 * @param pageIndex 查询的页索引
 * @param pageSize 查询的页大小
 * @return Voice[] 音色对象数组
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public Voice[] listVoice(String prefix, int pageIndex, int pageSize) throws NoApiKeyException, InputRequiredException

请求示例

import com.alibaba.dashscope.audio.ttsv2.enrollment.Voice;
import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.google.gson.Gson;

import static java.lang.System.exit;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
    private static String prefix = "prefix"; // 请按实际情况进行替换

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 查询音色
        Voice[] voices = service.listVoice(prefix, 0, 10);
        System.out.println("request id为：" + service.getLastRequestId());
        // 将voices打印成json
        Gson gson = new Gson();
        System.out.println("查询到的音色为：" + gson.toJson(voices));
        exit(0);
    }
}

响应示例

[
    {
        "gmt_create": "2024-09-13 11:29:41",
        "voice_id": "yourVoiceId",
        "gmt_modified": "2024-09-13 11:29:41",
        "status": "OK"
    },
    {
        "gmt_create": "2024-09-13 13:22:38",
        "voice_id": "yourVoiceId",
        "gmt_modified": "2024-09-13 13:22:38",
        "status": "OK"
    }
]

响应参数

接口说明

def query_voice(self, voice_id: str) -> List[str]:
    '''
    查询已创建的所有音色
    param: voice_id 需要查询的音色
    return: bytes 注册音色使用的音频
    '''

请求示例

import os
import dashscope
from dashscope.audio.tts_v2 import VoiceEnrollmentService

dashscope.api_key = os.getenv('DASHSCOPE_API_KEY')  # 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
voice_id = 'cosyvoice-v2-prefix-xxx' # 请按实际情况进行替换

# 创建语音注册服务实例
service = VoiceEnrollmentService()

voice = service.query_voice(voice_id=voice_id)
print("request id为：", service.get_last_request_id())
print(f"查询到的音色为：{voice}")

响应示例

{
    "gmt_create": "2024-09-13 11:29:41",
    "resource_link": "https://yourAudioFileUrl",
    "target_model": "cosyvoice-v2",
    "gmt_modified": "2024-09-13 11:29:41",
    "status": "OK"
}

响应参数

接口说明

/**
 * 查询指定音色
 *
 * @param voiceId 需要查询的音色
 * @return Voice 音色对象，包含状态信息和用于声音复刻的音频文件url
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public Voice queryVoice(String voiceId) throws NoApiKeyException, InputRequiredException

请求示例

import com.alibaba.dashscope.audio.ttsv2.enrollment.Voice;
import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.google.gson.Gson;

import static java.lang.System.exit;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
    private static String voiceId = "cosyvoice-v2-prefix-xxx"; // 请按实际情况进行替换

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 查询音色
        Voice voice = service.queryVoice(voiceId);
        System.out.println("request id为：" + service.getLastRequestId());
        // 将voices打印成json
        Gson gson = new Gson();
        System.out.println("查询到的音色为：" + gson.toJson(voice));
        exit(0);
    }
}

响应示例

{
    "gmt_create": "2024-09-13 11:29:41",
    "resource_link": "https://yourAudioFileUrl",
    "target_model": "cosyvoice-v2",
    "gmt_modified": "2024-09-13 11:29:41",
    "status": "OK"
}

响应参数

接口说明

def update_voice(self, voice_id: str, url: str) -> None:
    '''
    更新音色
    param: voice_id 音色id
    param: url 用于声音复刻的音频文件url
    '''

请求示例

import os
import dashscope
from dashscope.audio.tts_v2 import VoiceEnrollmentService

dashscope.api_key = os.getenv('DASHSCOPE_API_KEY')  # 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
url = "https://your-audio-file-url"  # 请按实际情况进行替换
voice_id = 'cosyvoice-v2-prefix-xxx' # 请按实际情况进行替换

# 创建语音注册服务实例
service = VoiceEnrollmentService()

service.update_voice(voice_id=voice_id, url=url)
print("request id为：", service.get_last_request_id())

接口说明

/**
 * 更新音色
 *
 * @param voiceId 需要更新的音色
 * @param url 用于声音复刻的音频文件url
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public void updateVoice(String voiceId, String url)
    throws NoApiKeyException, InputRequiredException

请求示例

import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;

import static java.lang.System.exit;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
    private static String fileUrl = "https://your-audio-file-url";  // 请按实际情况进行替换
    private static String voiceId = "cosyvoice-v2-prefix-xxx"; // 请按实际情况进行替换

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 更新音色
        service.updateVoice(voiceId, fileUrl);
        System.out.println("request id为：" + service.getLastRequestId());
        exit(0);
    }
}

接口说明

def delete_voice(self, voice_id: str) -> None:
    '''
    删除音色
    param: voice_id 需要删除的音色
    '''

请求示例

import os
import dashscope
from dashscope.audio.tts_v2 import VoiceEnrollmentService

dashscope.api_key = os.getenv('DASHSCOPE_API_KEY')  # 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
voice_id = 'cosyvoice-v2-prefix-xxx' # 请按实际情况进行替换

# 创建语音注册服务实例
service = VoiceEnrollmentService()

service.delete_voice(voice_id=voice_id)
print("request id为：", service.get_last_request_id())

接口说明

/**
 * 删除音色
 *
 * @param voiceId 需要删除的音色
 * @throws NoApiKeyException 如果apikey为空
 * @throws InputRequiredException 如果必须参数为空
 */
public void deleteVoice(String voiceId) throws NoApiKeyException, InputRequiredException 

请求示例

import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;

import static java.lang.System.exit;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 如果您没有配置环境变量，请在此处用您的API-KEY进行替换
    private static String voiceId = "cosyvoice-v2-prefix-xxx"; // 请按实际情况进行替换

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 删除音色
        service.deleteVoice(voiceId);
        System.out.println("request id为：" + service.getLastRequestId());
        exit(0);
    }
}