Models - Create

Referenz

Service:: Cognitive Services - Custom Voice

API Version:: 2023-12-01-preview

Erstellt ein neues Stimmmodell.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://eastus.api.cognitive.microsoft.com
id	path	True	string	Die ID der Ressource. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

endpoint

path

True

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://eastus.api.cognitive.microsoft.com

path

True

string

Die ID der Ressource.

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

api-version

query

True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung

Ocp-Apim-Subscription-Key

True

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Speech-Ressourcenschlüssel an.
Operation-Id		string	ID des status-Monitors für den Vorgang. Wenn der Operation-Id-Header mit einem vorhandenen Vorgang übereinstimmt und die Anforderung nicht mit der vorherigen Anforderung identisch ist, schlägt er mit einer ungültigen 400-Anforderung fehl. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Operation-Id

string

ID des status-Monitors für den Vorgang. Wenn der Operation-Id-Header mit einem vorhandenen Vorgang übereinstimmt und die Anforderung nicht mit der vorherigen Anforderung identisch ist, schlägt er mit einer ungültigen 400-Anforderung fehl.

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
consentId	True	string	Ressourcen-ID
projectId	True	string	Ressourcen-ID
recipe	True	Recipe	Rezept für die Modellerstellung. Verschiedene Rezepte haben unterschiedliche Funktionen.
trainingSetId	True	string	Ressourcen-ID
description		string	Modellbeschreibung
id		string	Ressourcen-ID
locale		string	Das Gebietsschema dieses Modells. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Modelleigenschaften
status		Status	Status einer Ressource.
voiceName		string	Name der Stimme

Antworten

Name	Typ	Beschreibung
201 Created	Model	Erstellt Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

201 Created

Model

Erstellt

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
Error	Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.
ErrorCode	Fehlercode der obersten Ebene
ErrorResponse	Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.
InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
Model	Modellobjekt
ModelFailureReason	Fehlerursache des Modelltrainings
ModelProperties	Modelleigenschaften
PresetStyleItem	Voreingestellte Stile, die vom Rezept unterstützt werden. Das Stimmmodell kann diese Stile ohne einen Stiltrainingssatz unterstützen.
Recipe	Rezept für die Modellerstellung. Verschiedene Rezepte haben unterschiedliche Funktionen.
Status	Status einer Ressource.

Error

Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode der obersten Ebene
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innererror	InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
message	string	Fehlermeldung der obersten Ebene.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

ErrorCode

Fehlercode der obersten Ebene

Name	Typ	Beschreibung
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.

Name	Typ	Beschreibung
error	Error	Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

InnerError

Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Unterstützung der Diagnose.
innererror	InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
message	string	Ausführliche Fehlermeldung.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

Model

Modellobjekt

Name	Typ	Beschreibung
consentId	string	Ressourcen-ID
createdDateTime	string	Der Zeitstempel, bei dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("YYYY-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modellbeschreibung
engineVersion	string	Engine-Version. Wenn Sie diese Version aktualisieren, können Sie den neuesten Aussprachefehler beheben.
id	string	Ressourcen-ID
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("YYYY-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Das Gebietsschema dieses Modells. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Ressourcen-ID
properties	ModelProperties	Modelleigenschaften
recipe	Recipe	Rezept für die Modellerstellung. Verschiedene Rezepte haben unterschiedliche Funktionen.
status	Status	Status einer Ressource.
trainingSetId	string	Ressourcen-ID
voiceName	string	Name der Stimme

ModelFailureReason

Fehlerursache des Modelltrainings

Name	Typ	Beschreibung
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Modelleigenschaften

Name	Typ	Beschreibung
failureReason	ModelFailureReason	Fehlerursache des Modelltrainings
presetStyles	string[]	Voreingestellte Stile dieses Modells.
styleTrainingSetIds	object	Angepasste Stile und zugeordnete Trainingssätze.
voiceStyles	string[]	Alle von diesem Modell unterstützten Stile.

PresetStyleItem

Voreingestellte Stile, die vom Rezept unterstützt werden. Das Stimmmodell kann diese Stile ohne einen Stiltrainingssatz unterstützen.

Name	Typ	Beschreibung
female	string[]	Voreingestellte Stile, die im Weiblichen Stimmmodell unterstützt werden.
male	string[]	Voreingestellte Stile, die im Männerstimmmodell unterstützt werden.

Recipe

Rezept für die Modellerstellung. Verschiedene Rezepte haben unterschiedliche Funktionen.

Name	Typ	Beschreibung
datasetLocales	string[]	Das Gebietsschema des Trainingsdatasets. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Rezeptbeschreibung
kind	string	Rezeptart
maxCustomStyleNum	integer	Maximale benutzerdefinierte Stilnummer, die in einem Stimmmodell unterstützt wird.
minStyleUtteranceCount	integer	Die minimale Anzahl von Äußerungen, die zum Trainieren der einzelnen benutzerdefinierten Stile erforderlich ist.
minUtteranceCount	integer	Mindestens erforderliche Anzahl von Äußerungen, um ein Stimmmodell mit diesem Rezept zu trainieren.
modelLocales	string[]	Das Gebietsschema, das ein Stimmmodell mit diesem Rezept sprechen kann. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Voreingestellte Stile, die von diesem Rezept pro Gebietsschema unterstützt werden. Sie können diese Stile ohne einen Stiltrainingssatz abrufen.
version	string	Rezeptversion

Status

Status einer Ressource.

Name	Typ	Beschreibung
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Models - Create

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Create a model

Sample Request

Sample Response

Create a multi style model

Sample Request

Sample Response

Definitionen

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Zusätzliche Ressourcen