Models - Create

Referencia

Szolgáltatás:: Cognitive Services - Custom Voice

API-verzió:: 2023-12-01-preview

Új hangmodellt hoz létre.

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	Az erőforrás azonosítója. Reguláris kifejezési minta: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	A művelethez használandó API-verzió.

endpoint

path

True

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://eastus.api.cognitive.microsoft.com).

path

True

string

Az erőforrás azonosítója.

Reguláris kifejezési minta: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name Kötelező Típus Description

Ocp-Apim-Subscription-Key

True

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Itt adja meg a Speech erőforráskulcsát.
Operation-Id		string	A művelet állapotfigyelőjének azonosítója. Ha a Operation-Id fejléc egy meglévő művelettel egyezik meg, és a kérés nem azonos az előző kéréssel, a 400 hibás kéréssel meghiúsul. Reguláris kifejezési minta: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Itt adja meg a Speech erőforráskulcsát.

Operation-Id

string

A művelet állapotfigyelőjének azonosítója. Ha a Operation-Id fejléc egy meglévő művelettel egyezik meg, és a kérés nem azonos az előző kéréssel, a 400 hibás kéréssel meghiúsul.

Reguláris kifejezési minta: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Kérelem törzse

Name	Kötelező	Típus	Description
consentId	True	string	Erőforrás-azonosító
projectId	True	string	Erőforrás-azonosító
recipe	True	Recipe	A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.
trainingSetId	True	string	Erőforrás-azonosító
description		string	Modell leírása
id		string	Erőforrás-azonosító
locale		string	A modell területi beállítása. A területi kód a BCP-47-et követi. A beszéd területi beállítási listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
properties		ModelProperties	Modell tulajdonságai
status		Status	Egy erőforrás állapota.
voiceName		string	Hangnév

Válaszok

Name	Típus	Description
201 Created	Model	Létrehozva Fejlécek Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Name

Típus

Description

201 Created

Model

Létrehozva

Fejlécek

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Speech erőforráskulcsát.

Típus: apiKey
In: header

Példák

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

{
  "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

{
  "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"
}

Definíciók

Name	Description
Error	A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és belső hibát tartalmaz, leíróbb részletekkel.
ErrorCode	Legfelső szintű hibakód
ErrorResponse	A hibaválasz a Következő címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorselérhető Microsoft Azure REST API-irányelveket követi: .
InnerError	A belső hiba a Microsoft Azure REST API-irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez tartalmazza a szükséges tulajdonságok hibakódját, üzenetét és választható tulajdonságcélját, belső hibáját (ez beágyazható).
Model	Modellobjektum
ModelFailureReason	Modell betanítási hibájának oka
ModelProperties	Modell tulajdonságai
PresetStyleItem	A recept által támogatott előre beállított stílusok. A hangmodell a stílusok betanítási készlete nélkül is támogatja ezeket a stílusokat.
Recipe	A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.
Status	Egy erőforrás állapota.

Error

A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és belső hibát tartalmaz, leíróbb részletekkel.

Name	Típus	Description
code	ErrorCode	Legfelső szintű hibakód
details	Error[]	További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innererror	InnerError	A belső hiba a Microsoft Azure REST API-irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez tartalmazza a szükséges tulajdonságok hibakódját, üzenetét és választható tulajdonságcélját, belső hibáját (ez beágyazható).
message	string	Felső szintű hibaüzenet.
target	string	A hiba forrása. Érvénytelen modell esetén például "modell" vagy "modellazonosító".

ErrorCode

Legfelső szintű hibakód

Name	Típus	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

A hibaválasz a Következő címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorselérhető Microsoft Azure REST API-irányelveket követi: .

Name	Típus	Description
error	Error	A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és belső hibát tartalmaz, leíróbb részletekkel.

InnerError

A belső hiba a Microsoft Azure REST API-irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez tartalmazza a szükséges tulajdonságok hibakódját, üzenetét és választható tulajdonságcélját, belső hibáját (ez beágyazható).

Name	Típus	Description
code	string	Részletes hibakód a diagnosztikához.
innererror	InnerError	A belső hiba a Microsoft Azure REST API-irányelveit követi, amely a címen https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsérhető el. Ez tartalmazza a szükséges tulajdonságok hibakódját, üzenetét és választható tulajdonságcélját, belső hibáját (ez beágyazható).
message	string	Részletes hibaüzenet.
target	string	A hiba forrása. Érvénytelen modell esetén például "modell" vagy "modellazonosító".

Model

Modellobjektum

Name	Típus	Description
consentId	string	Erőforrás-azonosító
createdDateTime	string	Az objektum létrehozásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modell leírása
engineVersion	string	Motorverzió. Ennek a verziónak a frissítése lekérheti a kiejtési hibák legújabb javítását.
id	string	Erőforrás-azonosító
lastActionDateTime	string	Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A modell területi beállítása. A területi kód a BCP-47-et követi. A beszéd területi beállítási listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
projectId	string	Erőforrás-azonosító
properties	ModelProperties	Modell tulajdonságai
recipe	Recipe	A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.
status	Status	Egy erőforrás állapota.
trainingSetId	string	Erőforrás-azonosító
voiceName	string	Hangnév

ModelFailureReason

Modell betanítási hibájának oka

Name	Típus	Description
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Modell tulajdonságai

Name	Típus	Description
failureReason	ModelFailureReason	Modell betanítási hibájának oka
presetStyles	string[]	A modell előre beállított stílusai.
styleTrainingSetIds	object	Testre szabott stílusok és a hozzá tartozó betanítási csoportok.
voiceStyles	string[]	A modell által támogatott összes stílus.

PresetStyleItem

A recept által támogatott előre beállított stílusok. A hangmodell a stílusok betanítási készlete nélkül is támogatja ezeket a stílusokat.

Name	Típus	Description
female	string[]	A női hangmodellben támogatott előre beállított stílusok.
male	string[]	A férfi hangmodellben támogatott előre beállított stílusok.

Recipe

A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.

Name	Típus	Description
datasetLocales	string[]	A betanítási adatkészlet területi beállítása. A területi kód a BCP-47-et követi. A beszéd területi beállítási listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
description	string	Recept leírása
kind	string	Recept típusa
maxCustomStyleNum	integer	Egy hangmodellben támogatott maximális egyéni stílusszám.
minStyleUtteranceCount	integer	Az egyes testreszabott stílusok betanításához minimális beszédelemszám szükséges.
minUtteranceCount	integer	A hangmodell ezzel a recepttel történő betanításához minimális beszédelemszám szükséges.
modelLocales	string[]	Az a területi beállítás, amellyel a hangmodell beszélni tud ezzel a recepttel. A területi kód a BCP-47-et követi. A beszéd területi beállítási listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
presetStyles	<string, PresetStyleItem>	A recept által támogatott előre beállított stílusok területi beállításonként. Ezeket a stílusokat stílusbetanítási csoport nélkül is beszerezheti.
version	string	Recept verziója

Status

Egy erőforrás állapota.

Name	Típus	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Megosztás a következőn keresztül:

Models - Create

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

Ocp-Apim-Subscription-Key

Példák

Create a model

Sample request

Sample response

Create a multi style model

Sample request

Sample response

Definíciók

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

További források