Alibaba Cloud Model Studio:CosyVoice voice cloning API

API の説明

def create_voice(self, target_model: str, prefix: str, url: str, language_hints: List[str] = None) -> str:
    '''
    新しいカスタムボイスを作成します。
    param: target_model 音声を駆動する音声合成モデル。後で音声合成 API を呼び出すときに使用する音声合成モデルと同じでなければなりません。そうでない場合、合成は失敗します。推奨モデルは cosyvoice-v3-flash または cosyvoice-v3-plus です。
    param: prefix 音声の分かりやすい名前 (数字、大文字と小文字のアルファベット、アンダースコアのみ使用可能、10 文字まで)。ロールやシナリオに関連する識別子を使用してください。このキーワードはクローンされた音声名に表示されます。生成される音声名の形式は model_name-prefix-unique_identifier です。例：cosyvoice-v3-plus-myvoice-xxxxxxxx。
    param: url 音声クローン用の音声ファイルの URL。URL は一般公開されている必要があります。
    param: language_hints ターゲットの音声特徴を抽出するために使用されるサンプル音声の言語を指定します。このパラメーターは cosyvoice-v3-flash および cosyvoice-v3-plus モデルにのみ適用されます。
            モデルがサンプル音声 (元の参照音声) の言語を識別し、音声特徴をより正確に抽出し、クローン結果を向上させるのに役立ちます。
            指定された言語ヒントが実際の音声言語と一致しない場合 (例：中国語の音声ファイルに 'en' を設定)、システムはヒントを無視し、音声コンテンツから言語を自動的に検出します。
            有効値：zh (デフォルト)、en、fr、de、ja、ko、ru。このパラメーターは配列ですが、現在のバージョンでは最初の要素のみが処理されます。1 つの値のみを渡してください。
    return: voice_id 音声 ID。音声合成 API の voice パラメーターに直接使用できます。
    '''

リクエスト例

from dashscope.audio.tts_v2 import VoiceEnrollmentService

service = VoiceEnrollmentService()

# 頻繁な呼び出しは避けてください。各呼び出しで新しい音声が作成されます。クォータ制限に達すると、それ以上音声を作成できなくなります。
voice_id = service.create_voice(
    target_model='cosyvoice-v3-plus',
    prefix='myvoice',
    url='https://your-audio-file-url',
    language_hints=['en']
)

print(f"リクエスト ID: {service.get_last_request_id()}")
print(f"音声 ID: {voice_id}")

API の説明

/**
 * 新しいカスタムボイスを作成します。
 *
 * @param targetModel 音声を駆動する音声合成モデル。後で音声合成 API を呼び出すときに使用する音声合成モデルと同じでなければなりません。そうでない場合、合成は失敗します。推奨モデルは cosyvoice-v3-flash または cosyvoice-v3-plus です。
 * @param prefix 音声の分かりやすい名前 (数字、大文字と小文字のアルファベット、アンダースコアのみ使用可能、10 文字まで)。ロールやシナリオに関連する識別子を使用してください。このキーワードはクローンされた音声名に表示されます。生成される音声名の形式は model_name-prefix-unique_identifier です。例：cosyvoice-v3-plus-myvoice-xxxxxxxx。
 * @param url 音声クローン用の音声ファイルの URL。URL は一般公開されている必要があります。
 * @param customParam カスタムパラメーター。ここで languageHints を指定できます。
 *                  languageHints は、ターゲットの音声特徴を抽出するために使用されるサンプル音声の言語を指定します。このパラメーターは cosyvoice-v3-flash および cosyvoice-v3-plus モデルにのみ適用されます。
 *                  モデルがサンプル音声 (元の参照音声) の言語を識別し、音声特徴をより正確に抽出し、クローン結果を向上させるのに役立ちます。
 *                  指定された言語ヒントが実際の音声言語と一致しない場合 (例：中国語の音声ファイルに 'en' を設定)、システムはヒントを無視し、音声コンテンツから言語を自動的に検出します。
 *                  有効値：zh (デフォルト)、en、fr、de、ja、ko、ru。このパラメーターは配列ですが、現在のバージョンでは最初の要素のみが処理されます。1 つの値のみを渡してください。
 * @return Voice 新しく作成された音声。Voice オブジェクトの getVoiceId メソッドを使用して音声 ID を取得できます。ID は音声合成 API の voice パラメーターに直接使用できます。
 * @throws NoApiKeyException API キーが空の場合。
 * @throws InputRequiredException 必須パラメーターが空の場合。
 */
public Voice createVoice(String targetModel, String prefix, String url, VoiceEnrollmentParam customParam) throws NoApiKeyException, InputRequiredException

リクエスト例

import com.alibaba.dashscope.audio.ttsv2.enrollment.Voice;
import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentParam;
import com.alibaba.dashscope.audio.ttsv2.enrollment.VoiceEnrollmentService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Collections;

public class Main {
    private static final Logger logger = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args) {
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        String targetModel = "cosyvoice-v3-plus";
        String prefix = "myvoice";
        String fileUrl = "https://your-audio-file-url";
        String cloneModelName = "voice-enrollment";

        try {
            VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
            Voice myVoice = service.createVoice(
                    targetModel,
                    prefix,
                    fileUrl,
                    VoiceEnrollmentParam.builder()
                    .model(cloneModelName)
                    .languageHints(Collections.singletonList("en")).build());

            logger.info("音声作成が送信されました。リクエスト ID: {}", service.getLastRequestId());
            logger.info("生成された音声 ID: {}", myVoice.getVoiceId());
        } catch (Exception e) {
            logger.error("音声の作成に失敗しました", e);
        }
    }
}

API の説明

def list_voices(self, prefix=None, page_index: int = 0, page_size: int = 10) -> List[dict]:
    '''
    作成されたすべての音声をクエリします。
    param: prefix 音声のカスタムプレフィックス。数字と小文字のみ使用可能、10 文字まで。
    param: page_index クエリのページインデックス。
    param: page_size クエリのページサイズ。
    return: List[dict] 音声のリスト。各音声の ID、作成時間、変更時間、ステータスが含まれます。形式：[{'gmt_create': '2025-10-09 14:51:01', 'gmt_modified': '2025-10-09 14:51:07', 'status': 'OK', 'voice_id': 'cosyvoice-v3-myvoice-xxx'}]
    音声ステータスは 3 種類あります：
        DEPLOYING：審査中
        OK：承認済み、使用可能
        UNDEPLOYED：未承認、使用不可
    '''

リクエスト例

from dashscope.audio.tts_v2 import VoiceEnrollmentService

service = VoiceEnrollmentService()

# プレフィックスでフィルタリングするか、None に設定してすべてをクエリします。
voices = service.list_voices(prefix='myvoice', page_index=0, page_size=10)

print(f"リクエスト 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"
    }
]

レスポンスパラメーター

API の説明

// 音声ステータスは 3 種類あります：
//        DEPLOYING：審査中
//        OK：承認済み、使用可能
//        UNDEPLOYED：未承認、使用不可
/**
 * 作成されたすべての音声をクエリします。デフォルトのページインデックスは 0、デフォルトのページサイズは 10 です。
 *
 * @param prefix 音声のカスタムプレフィックス。数字と小文字のみ使用可能、10 文字まで。null も可。
 * @return Voice[] Voice オブジェクトの配列。Voice オブジェクトは、音声 ID、作成時間、変更時間、ステータスをカプセル化します。
 * @throws NoApiKeyException API キーが空の場合。
 * @throws InputRequiredException 必須パラメーターが空の場合。
 */
public Voice[] listVoice(String prefix) throws NoApiKeyException, InputRequiredException 

/**
 * 作成されたすべての音声をクエリします。
 *
 * @param prefix 音声のカスタムプレフィックス。数字と小文字のみ使用可能、10 文字まで。
 * @param pageIndex クエリのページインデックス。
 * @param pageSize クエリのページサイズ。
 * @return Voice[] Voice オブジェクトの配列。Voice オブジェクトは、音声 ID、作成時間、変更時間、ステータスをカプセル化します。
 * @throws NoApiKeyException API キーが空の場合。
 * @throws InputRequiredException 必須パラメーターが空の場合。
 */
public Voice[] listVoice(String prefix, int pageIndex, int pageSize) throws NoApiKeyException, InputRequiredException

リクエスト例

サードパーティライブラリ com.google.gson.Gson をインポートする必要があります。

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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 環境変数を設定していない場合は、API キーに置き換えてください。
    private static String prefix = "myvoice"; // 実際の値に置き換えてください。
    private static final Logger logger = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 音声をクエリします。
        Voice[] voices = service.listVoice(prefix, 0, 10);
        logger.info("リスト取得に成功しました。リクエスト ID: {}", service.getLastRequestId());
        logger.info("音声の詳細: {}", new Gson().toJson(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"
    }
]

レスポンスパラメーター

API の説明

def query_voice(self, voice_id: str) -> List[str]:
    '''
    特定の音声の詳細をクエリします。
    param: voice_id クエリする音声の ID。
    return: List[str] 音声の詳細。ステータス、作成時間、音声リンクなどが含まれます。
    '''

リクエスト例

from dashscope.audio.tts_v2 import VoiceEnrollmentService

service = VoiceEnrollmentService()
voice_id = 'cosyvoice-v3-plus-myvoice-xxxxxxxx'

voice_details = service.query_voice(voice_id=voice_id)

print(f"リクエスト ID: {service.get_last_request_id()}")
print(f"音声の詳細: {voice_details}")

レスポンス例

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

レスポンスパラメーター

API の説明

/**
 * 特定の音声の詳細をクエリします。
 *
 * @param voiceId クエリする音声の ID。
 * @return Voice 音声の詳細。ステータス、作成時間、音声リンクなどが含まれます。
 * @throws NoApiKeyException API キーが空の場合。
 * @throws InputRequiredException 必須パラメーターが空の場合。
 */
public Voice queryVoice(String voiceId) throws NoApiKeyException, InputRequiredException

リクエスト例

サードパーティライブラリ com.google.gson.Gson をインポートする必要があります。

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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 環境変数を設定していない場合は、API キーに置き換えてください。
    private static String voiceId = "cosyvoice-v3-plus-myvoice-xxx"; // 実際の値に置き換えてください。
    private static final Logger logger = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        Voice voice = service.queryVoice(voiceId);
        
        logger.info("クエリに成功しました。リクエスト ID: {}", service.getLastRequestId());
        logger.info("音声の詳細: {}", new Gson().toJson(voice));
    }
}

レスポンス例

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

レスポンスパラメーター

API の説明

def update_voice(self, voice_id: str, url: str) -> None:
    '''
    音声を更新します。
    param: voice_id 音声の ID。
    param: url 音声クローン用の音声ファイルの URL。
    '''

リクエスト例

from dashscope.audio.tts_v2 import VoiceEnrollmentService

service = VoiceEnrollmentService()
service.update_voice(
    voice_id='cosyvoice-v3-plus-myvoice-xxxxxxxx',
    url='https://your-new-audio-file-url'
)
print(f"更新が送信されました。リクエスト ID: {service.get_last_request_id()}")

API の説明

/**
 * 音声を更新します。
 *
 * @param voiceId 更新する音声。
 * @param url 音声クローン用の音声ファイルの URL。
 * @throws NoApiKeyException API キーが空の場合。
 * @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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 環境変数を設定していない場合は、API キーに置き換えてください。
    private static String fileUrl = "https://your-audio-file-url";  // 実際の値に置き換えてください。
    private static String voiceId = "cosyvoice-v3-plus-myvoice-xxx"; // 実際の値に置き換えてください。
    private static final Logger logger = LoggerFactory.getLogger(Main.class);
    
    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 音声を更新します。
        service.updateVoice(voiceId, fileUrl);
        logger.info("更新が送信されました。リクエスト ID: {}", service.getLastRequestId());
    }
}

API の説明

def delete_voice(self, voice_id: str) -> None:
    '''
    音声を削除します。
    param: voice_id 削除する音声。
    '''

リクエスト例

from dashscope.audio.tts_v2 import VoiceEnrollmentService

service = VoiceEnrollmentService()
service.delete_voice(voice_id='cosyvoice-v3-plus-myvoice-xxxxxxxx')
print(f"削除が送信されました。リクエスト ID: {service.get_last_request_id()}")

API の説明

/**
 * 音声を削除します。
 *
 * @param voiceId 削除する音声。
 * @throws NoApiKeyException API キーが空の場合。
 * @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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");  // 環境変数を設定していない場合は、API キーに置き換えてください。
    private static String voiceId = "cosyvoice-v3-plus-myvoice-xxx"; // 実際の値に置き換えてください。
    private static final Logger logger = LoggerFactory.getLogger(Main.class);
    
    public static void main(String[] args)
            throws NoApiKeyException, InputRequiredException {
        VoiceEnrollmentService service = new VoiceEnrollmentService(apiKey);
        // 音声を削除します。
        service.deleteVoice(voiceId);
        logger.info("削除が送信されました。リクエスト ID: {}", service.getLastRequestId());
    }
}