Models - Create

Referensi

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Membuat model suara baru.

PUT {endpoint}/customvoice/models/{id}?api-version=2023-12-01-preview

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	ID sumber daya. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

endpoint

path

True

string

Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://eastus.api.cognitive.microsoft.com).

path

True

string

ID sumber daya.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan Jenis Deskripsi

Ocp-Apim-Subscription-Key

True

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Berikan kunci sumber daya Ucapan Anda di sini.
Operation-Id		string	ID monitor status untuk operasi. Jika header Operation-Id cocok dengan operasi yang ada dan permintaan tidak identik dengan permintaan sebelumnya, itu akan gagal dengan 400 Permintaan Buruk. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Berikan kunci sumber daya Ucapan Anda di sini.

Operation-Id

string

ID monitor status untuk operasi. Jika header Operation-Id cocok dengan operasi yang ada dan permintaan tidak identik dengan permintaan sebelumnya, itu akan gagal dengan 400 Permintaan Buruk.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
consentId	True	string	Id sumber daya
projectId	True	string	Id sumber daya
recipe	True	Recipe	Resep untuk bangunan model. Resep yang berbeda memiliki kemampuan yang berbeda.
trainingSetId	True	string	Id sumber daya
description		string	Deskripsi model
id		string	Id sumber daya
locale		string	Lokal model ini. Kode lokal mengikuti BCP-47. Anda dapat menemukan daftar lokal teks ke ucapan di sini https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Properti model
status		Status	Status sumber daya.
voiceName		string	Nama suara

Respons

Nama	Jenis	Deskripsi
201 Created	Model	Dibuat Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Nama

Jenis

Deskripsi

201 Created

Model

Dibuat

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci sumber daya Ucapan Anda di sini.

Type: apiKey
In: header

Contoh

Create a model

Create a multi style model

Create a model

Sample Request

HTTP

PUT {endpoint}/customvoice/models/Jessica?api-version=2023-12-01-preview



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

Sample Response

Status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2023-12-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

Response Body

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Create a multi style model

Sample Request

HTTP

PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2023-12-01-preview



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

Sample Response

Status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2023-12-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

Response Body

{
  "id": "JessicaMultiStyle",
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definisi

Nama	Deskripsi
Error	Kesalahan tingkat atas mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kesalahan tingkat atas dengan kode kesalahan, pesan, detail, target, dan kesalahan dalam dengan detail yang lebih deskriptif.
ErrorCode	Kode kesalahan tingkat atas
ErrorResponse	Respons kesalahan mengikuti Panduan MICROSOFT Azure REST API yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Kesalahan dalam mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kode kesalahan properti yang diperlukan, pesan, dan target properti opsional, kesalahan dalam (ini dapat ditumpuk).
Model	Objek model
ModelFailureReason	Alasan kegagalan pelatihan model
ModelProperties	Properti model
PresetStyleItem	Gaya preset yang didukung oleh resep. Model suara dapat mendukung gaya ini tanpa set pelatihan gaya apa pun.
Recipe	Resep untuk bangunan model. Resep yang berbeda memiliki kemampuan yang berbeda.
Status	Status sumber daya.

Error

Kesalahan tingkat atas mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kesalahan tingkat atas dengan kode kesalahan, pesan, detail, target, dan kesalahan dalam dengan detail yang lebih deskriptif.

Nama	Jenis	Deskripsi
code	ErrorCode	Kode kesalahan tingkat atas
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innererror	InnerError	Kesalahan dalam mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kode kesalahan properti yang diperlukan, pesan, dan target properti opsional, kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat atas.
target	string	Sumber kesalahan. Misalnya itu akan menjadi "model" atau "id model" jika model tidak valid.

ErrorCode

Kode kesalahan tingkat atas

Nama	Jenis	Deskripsi
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Respons kesalahan mengikuti Panduan MICROSOFT Azure REST API yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nama	Jenis	Deskripsi
error	Error	Kesalahan tingkat atas mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kesalahan tingkat atas dengan kode kesalahan, pesan, detail, target, dan kesalahan dalam dengan detail yang lebih deskriptif.

InnerError

Kesalahan dalam mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kode kesalahan properti yang diperlukan, pesan, dan target properti opsional, kesalahan dalam (ini dapat ditumpuk).

Nama	Jenis	Deskripsi
code	string	Kode kesalahan terperinci untuk membantu diagnostik.
innererror	InnerError	Kesalahan dalam mengikuti Panduan REST API Microsoft Azure yang tersedia di https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ini berisi kode kesalahan properti yang diperlukan, pesan, dan target properti opsional, kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan terperinci.
target	string	Sumber kesalahan. Misalnya itu akan menjadi "model" atau "id model" jika model tidak valid.

Model

Objek model

Nama	Jenis	Deskripsi
consentId	string	Id sumber daya
createdDateTime	string	Tanda waktu saat objek dibuat. Tanda waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Deskripsi model
engineVersion	string	Versi mesin. Perbarui versi ini bisa mendapatkan perbaikan bug pengucapan terbaru.
id	string	Id sumber daya
lastActionDateTime	string	Tanda waktu ketika status saat ini dimasukkan. Tanda waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Lokal model ini. Kode lokal mengikuti BCP-47. Anda dapat menemukan daftar lokal teks ke ucapan di sini https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Id sumber daya
properties	ModelProperties	Properti model
recipe	Recipe	Resep untuk bangunan model. Resep yang berbeda memiliki kemampuan yang berbeda.
status	Status	Status sumber daya.
trainingSetId	string	Id sumber daya
voiceName	string	Nama suara

ModelFailureReason

Alasan kegagalan pelatihan model

Nama	Jenis	Deskripsi
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Properti model

Nama	Jenis	Deskripsi
failureReason	ModelFailureReason	Alasan kegagalan pelatihan model
presetStyles	string[]	Gaya preset model ini.
styleTrainingSetIds	object	Gaya yang dikustomisasi dan set pelatihan terkait.
voiceStyles	string[]	Semua gaya yang didukung oleh model ini.

PresetStyleItem

Gaya preset yang didukung oleh resep. Model suara dapat mendukung gaya ini tanpa set pelatihan gaya apa pun.

Nama	Jenis	Deskripsi
female	string[]	Gaya prasetel didukung pada model suara wanita.
male	string[]	Gaya prasetel didukung pada model suara pria.

Recipe

Resep untuk bangunan model. Resep yang berbeda memiliki kemampuan yang berbeda.

Nama	Jenis	Deskripsi
datasetLocales	string[]	Lokal himpunan data pelatihan. Kode lokal mengikuti BCP-47. Anda dapat menemukan daftar lokal teks ke ucapan di sini https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Deskripsi resep
kind	string	Jenis resep
maxCustomStyleNum	integer	Nomor gaya maksimum yang disesuaikan didukung dalam satu model suara.
minStyleUtteranceCount	integer	Jumlah ucapan minimum yang diperlukan untuk melatih setiap gaya yang disesuaikan.
minUtteranceCount	integer	Jumlah ucapan minimum yang diperlukan untuk melatih model suara dengan resep ini.
modelLocales	string[]	Lokal yang dapat diucapkan model suara dengan resep ini. Kode lokal mengikuti BCP-47. Anda dapat menemukan daftar lokal teks ke ucapan di sini https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Gaya preset yang didukung oleh resep ini per lokal. Anda bisa mendapatkan gaya ini tanpa set pelatihan gaya apa pun.
version	string	Versi resep

Status

Status sumber daya.

Nama	Jenis	Deskripsi
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Share via

Models - Create

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

Contoh

Create a model

Sample Request

Sample Response

Create a multi style model

Sample Request

Sample Response

Definisi

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Sumber Daya Tambahan: