Models - Create

新しいボイスモデルを作成します。

PUT {endpoint}/customvoice/models/{id}?api-version=2026-01-01

URI パラメーター

名前 / 必須 説明
endpoint
path True

string (uri)

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://eastus.api.cognitive.microsoft.com)。

id
path True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 説明
Operation-Id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

作戦のステータスモニターのID。 Operation-Id ヘッダーが既存の操作と一致し、リクエストが前のリクエストと同一でない場合、400 Bad Requestで失敗します。

要求本文

名前 必須 説明
consentId True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

projectId True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

recipe True

Recipe

模型作りのレシピ。 レシピによって能力は異なります。

trainingSetId True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

description

string

モデルの説明

locale

string

このモデルの所在地。 地域コードはBCP-47に準拠しています。 テキスト読み上げのロケーション一覧はこちら https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsご覧いただけます。

properties

ModelProperties

モデルのプロパティ

status

Status

資源のステータス。

voiceName

string

minLength: 1

音声名

応答

名前 説明
200 OK

Model

要求は成功しました。

ヘッダー

Operation-Location: string

201 Created

Model

要求が成功し、結果として新しいリソースが作成されました。

ヘッダー

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

Create a model
Create a multi style model

Create a model

要求のサンプル

PUT {endpoint}/customvoice/models/Jessica?api-version=2026-01-01


{
  "description": "Jessica voice",
  "consentId": "Jessica",
  "projectId": "Jessica",
  "recipe": {
    "kind": "Default"
  },
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaNeural"
}

応答のサンプル

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2026-01-01
{
  "description": "Jessica voice",
  "consentId": "Jessica",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "engineVersion": "2023.07.04.0",
  "id": "Jessica",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "status": "NotStarted",
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaNeural"
}
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2026-01-01
{
  "description": "Jessica voice",
  "consentId": "Jessica",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "engineVersion": "2023.07.04.0",
  "id": "Jessica",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "status": "NotStarted",
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaNeural"
}

Create a multi style model

要求のサンプル

PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2026-01-01


{
  "description": "Jessica multi style voice",
  "consentId": "Jessica",
  "locale": "en-US",
  "projectId": "Jessica",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    }
  },
  "recipe": {
    "kind": "MultiStyle"
  },
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaMultiStyleNeural"
}

応答のサンプル

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2026-01-01
{
  "description": "Jessica multi style voice",
  "consentId": "Jessica",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "engineVersion": "2023.07.04.0",
  "id": "JessicaMultiStyle",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "status": "NotStarted",
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaMultiStyleNeural"
}
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2026-01-01
{
  "description": "Jessica multi style voice",
  "consentId": "Jessica",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "engineVersion": "2023.07.04.0",
  "id": "JessicaMultiStyle",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "status": "NotStarted",
  "trainingSetId": "Jessica-300",
  "voiceName": "JessicaMultiStyleNeural"
}

定義

名前 説明
Azure.Core.Foundations.Error

エラー オブジェクト。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors

Model

Model オブジェクト

ModelFailureReason

モデルトレーニング失敗の理由

ModelProperties

モデルのプロパティ

PresetStyleItem

レシピでサポートされているプリセットスタイル。 ボイスモデルはスタイルトレーニングセットなしでこれらのスタイルをサポートできます。

Recipe

模型作りのレシピ。 レシピによって能力は異なります。

Status

資源のステータス。

Azure.Core.Foundations.Error

エラー オブジェクト。

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

details

Azure.Core.Foundations.Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

Azure.Core.Foundations.InnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

message

string

エラーの人間が判読できる表現。

target

string

エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前 説明
error

Azure.Core.Foundations.Error

エラー オブジェクト。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 REST APIのガイドラインAzure https://aka.ms/AzureRestApiGuidelines#handling-errors

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

innererror

Azure.Core.Foundations.InnerError

内部エラー。

Model

Model オブジェクト

名前 説明
consentId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

createdDateTime

string (date-time)

オブジェクトが作成されたタイムスタンプ。 タイムスタンプはISO 8601の日付と時間フォーマット(「YYYY-MM-DDThh:mm:ssZ」、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照)でエンコードされています。

description

string

モデルの説明

engineVersion

string

エンジンのバージョン。 アップデート このバージョンは最新の発音バグ修正を受けられます。

id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

lastActionDateTime

string (date-time)

現在のステータスが入力されたタイムスタンプ。 タイムスタンプはISO 8601の日付と時間フォーマット(「YYYY-MM-DDThh:mm:ssZ」、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照)でエンコードされています。

locale

string

このモデルの所在地。 地域コードはBCP-47に準拠しています。 テキスト読み上げのロケーション一覧はこちら https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsご覧いただけます。

projectId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

properties

ModelProperties

モデルのプロパティ

recipe

Recipe

模型作りのレシピ。 レシピによって能力は異なります。

status

Status

資源のステータス。

trainingSetId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

リソース ID

voiceName

string

minLength: 1

音声名

ModelFailureReason

モデルトレーニング失敗の理由

説明
InaccessibleCustomerStorage

お客様はBring Your Own Storage in Speech Accountを使っています。 しかし、その保管場所は現在アクセスできません。 医師の方がいいですよ。

SpeakerVerificationFailed

同意音声とトレーニング音声は同じスピーカーからのものではありません。

TerminateByUser

顧客はモデルトレーニングをキャンセルしました。

Internal

カスタム音声サービスのエラーです。

DataNotReady

トレーニングデータはモデルトレーニングにまだ準備ができていません。

DataNotEnough

トレーニングデータだけではモデルトレーニングには不十分です。

ModelProperties

モデルのプロパティ

名前 説明
failedTrainingsets

string[]

失敗したトレーニングセットのIDです。

failureReason

ModelFailureReason

モデルトレーニング失敗の理由

presetStyles

string[]

このモデルのプリセットスタイル。

secondaryLocales

string[]

このモデルが話すことができる二次的な場所。 地域コードはBCP-47に準拠しています。

styleTrainingSetIds

object

カスタマイズスタイルと関連するトレーニングセット。

voiceStyles

string[]

このモデルでサポートされているすべてのスタイル。

PresetStyleItem

レシピでサポートされているプリセットスタイル。 ボイスモデルはスタイルトレーニングセットなしでこれらのスタイルをサポートできます。

名前 説明
female

string[]

女性音声モデルでプリセットスタイルをサポートしています。

male

string[]

男性の声モデルでサポートされるプリセットスタイル。

Recipe

模型作りのレシピ。 レシピによって能力は異なります。

名前 説明
datasetLocales

string[]

トレーニングデータセットの所在地です。 地域コードはBCP-47に準拠しています。 テキスト読み上げのロケーション一覧はこちら https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsご覧いただけます。

description

string

レシピの説明

kind

string

レシピの種類

maxCustomStyleNum

integer (int32)

1つの声のモデルで最大のサポートカスタマイズスタイル数。

minDurationInSeconds

number (double)

このレシピでボイスモデルを訓練するのに必要な最小音声持続時間(秒単位)です。

minStyleUtteranceCount

integer (int32)

各カスタマイズスタイルを訓練するために必要な最小発話数。

minUtteranceCount

integer (int32)

このレシピでボイスモデルを訓練するために必要な最小発話数。

modelLocales

string[]

このレシピでボイスモデルが話せる場所。 地域コードはBCP-47に準拠しています。 テキスト読み上げのロケーション一覧はこちら https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsご覧いただけます。

presetStyles

<string,  PresetStyleItem>

このレシピでサポートされている場所ごとのプリセットスタイル。 これらのスタイルは、スタイルトレーニングセットなしでも手に入れられます。

version

string

レシピ版

Status

資源のステータス。

説明
NotStarted

未開始

Running

Running

Succeeded

成功しました

Failed

失敗

Disabling

無効化

Disabled

Disabled