Models - Create
Hiermee maakt u een nieuw spraakmodel.
PUT {endpoint}/customvoice/models/{id}?api-version=2024-02-01-preview
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com). |
id
|
path | True |
string |
De id van de resource. Regex-patroon: |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Geef hier uw spraakresourcesleutel op. |
Operation-Id |
string |
Id van de statusmonitor voor de bewerking. Als de Operation-Id-header overeenkomt met een bestaande bewerking en de aanvraag niet identiek is aan de vorige aanvraag, mislukt deze met een ongeldige 400-aanvraag. Regex-patroon: |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
consentId | True |
string |
Resource-id |
projectId | True |
string |
Resource-id |
recipe | True |
Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden. |
|
trainingSetId | True |
string |
Resource-id |
description |
string |
Modelbeschrijving |
|
id |
string |
Resource-id |
|
locale |
string |
De landinstelling van dit model. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. |
|
properties |
Modeleigenschappen |
||
status |
Status van een resource. |
||
voiceName |
string |
Spraaknaam |
Antwoorden
Name | Type | Description |
---|---|---|
201 Created |
Gemaakt Kopteksten
|
|
Other Status Codes |
Er is een fout opgetreden. Kopteksten x-ms-error-code: string |
Beveiliging
Ocp-Apim-Subscription-Key
Geef hier uw spraakresourcesleutel op.
Type:
apiKey
In:
header
Voorbeelden
Create a model |
Create a multi style model |
Create a model
Voorbeeldaanvraag
PUT {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview
{
"voiceName": "JessicaNeural",
"description": "Jessica voice",
"recipe": {
"kind": "Default"
},
"projectId": "Jessica",
"consentId": "Jessica",
"trainingSetId": "Jessica-300"
}
Voorbeeldrespons
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2024-02-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
Voorbeeldaanvraag
PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2024-02-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"
}
}
}
Voorbeeldrespons
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2024-02-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"
}
Definities
Name | Description |
---|---|
Error |
Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details. |
Error |
Foutcode op het hoogste niveau |
Error |
Foutreactie volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. |
Inner |
Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest). |
Model |
Modelobject |
Model |
Reden van fout bij modeltraining |
Model |
Modeleigenschappen |
Preset |
Vooraf ingestelde stijlen die door het recept worden ondersteund. Het spraakmodel kan deze stijlen ondersteunen zonder een stijltrainingsset. |
Recipe |
Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden. |
Status |
Status van een resource. |
Error
Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.
Name | Type | Description |
---|---|---|
code |
Foutcode op het hoogste niveau |
|
details |
Error[] |
Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid. |
innererror |
Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest). |
|
message |
string |
Foutbericht op het hoogste niveau. |
target |
string |
De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model. |
ErrorCode
Foutcode op het hoogste niveau
Name | Type | Description |
---|---|---|
BadArgument |
string |
|
BadRequest |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
NotFound |
string |
|
ServiceUnavailable |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
UnsupportedMediaType |
string |
ErrorResponse
Foutreactie volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Name | Type | Description |
---|---|---|
error |
Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details. |
InnerError
Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).
Name | Type | Description |
---|---|---|
code |
string |
Gedetailleerde foutcode voor diagnostische gegevens. |
innererror |
Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest). |
|
message |
string |
Gedetailleerd foutbericht. |
target |
string |
De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model. |
Model
Modelobject
Name | Type | Description |
---|---|---|
consentId |
string |
Resource-id |
createdDateTime |
string |
De tijdstempel waarop het object is gemaakt. Het tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
description |
string |
Modelbeschrijving |
engineVersion |
string |
Engineversie. Bijwerken van deze versie kan de meest recente uitspraakfoutoplossing krijgen. |
id |
string |
Resource-id |
lastActionDateTime |
string |
De tijdstempel waarop de huidige status is ingevoerd. Het tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
locale |
string |
De landinstelling van dit model. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. |
projectId |
string |
Resource-id |
properties |
Modeleigenschappen |
|
recipe |
Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden. |
|
status |
Status van een resource. |
|
trainingSetId |
string |
Resource-id |
voiceName |
string |
Spraaknaam |
ModelFailureReason
Reden van fout bij modeltraining
Name | Type | Description |
---|---|---|
InaccessibleCustomerStorage |
string |
De klant gebruikt Bring Your Own Storage in Speech Account. Maar de opslag is nu niet toegankelijk. Raadpleeg het document. |
Internal |
string |
Custom Voice Service-fout. |
SpeakerVerificationFailed |
string |
De toestemmings- en trainingsaudio zijn niet afkomstig van dezelfde spreker. |
TerminateByUser |
string |
De klant heeft de modeltraining geannuleerd. |
ModelProperties
Modeleigenschappen
Name | Type | Description |
---|---|---|
failureReason |
Reden van fout bij modeltraining |
|
presetStyles |
string[] |
Vooraf ingestelde stijlen van dit model. |
styleTrainingSetIds |
object |
Aangepaste stijlen en bijbehorende trainingssets. |
voiceStyles |
string[] |
Alle stijlen die door dit model worden ondersteund. |
PresetStyleItem
Vooraf ingestelde stijlen die door het recept worden ondersteund. Het spraakmodel kan deze stijlen ondersteunen zonder een stijltrainingsset.
Name | Type | Description |
---|---|---|
female |
string[] |
Vooraf ingestelde stijlen die worden ondersteund op het vrouwelijke stemmodel. |
male |
string[] |
Vooraf ingestelde stijlen die worden ondersteund op het mannelijke stemmodel. |
Recipe
Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
Name | Type | Description |
---|---|---|
datasetLocales |
string[] |
De landinstelling van de trainingsgegevensset. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. |
description |
string |
Beschrijving van recept |
kind |
string |
Soort recept |
maxCustomStyleNum |
integer |
Maximaal aangepast stijlnummer dat wordt ondersteund in één spraakmodel. |
minStyleUtteranceCount |
integer |
Het minimale aantal uitingen dat is vereist om elke aangepaste stijl te trainen. |
minUtteranceCount |
integer |
Het minimale aantal uitingen dat is vereist om een spraakmodel te trainen met dit recept. |
modelLocales |
string[] |
De landinstelling die een spraakmodel met dit recept kan spreken. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. |
presetStyles |
<string,
Preset |
Vooraf ingestelde stijlen die door dit recept per landinstelling worden ondersteund. U kunt deze stijlen krijgen zonder stijltrainingsset. |
version |
string |
Receptversie |
Status
Status van een resource.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Disabling |
string |
|
Failed |
string |
|
NotStarted |
string |
|
Running |
string |
|
Succeeded |
string |