Models - Get

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

Ruft das durch die angegebene ID identifizierte Modell ab.

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

URI-Parameter

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.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Antworten

Name	Typ	Beschreibung
200 OK	Model	Erfolg
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

Get a model

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definitionen

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

Error

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

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

ErrorCode

Fehlercode auf oberster 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 ist.

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

InnerError

Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Unterstützung der Diagnose.
innererror	InnerError	Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies 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 ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modellbeschreibung
engineVersion	string	Modulversion. Wenn Sie diese Version aktualisieren, können Sie die neuesten Aussprachefehler beheben.
id	string	Ressourcen-ID
lastActionDateTime	string	Der Zeitstempel, bei dem die aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh: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 Sprachtext 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 Sprachmodell kann diese Stile ohne Stiltraining unterstützen.

Name	Typ	Beschreibung
female	string[]	Voreingestellte Stile, die im weiblichen Stimmmodell unterstützt werden.
male	string[]	Voreingestellte Stile, die für männliche Sprachmodelle 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 Sprachtext 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 Anzahl benutzerdefinierter Stile, die in einem Sprachmodell unterstützt wird.
minStyleUtteranceCount	integer	Die mindeste Anzahl von Äußerungen, die zum Trainieren der benutzerdefinierten Stile erforderlich ist.
minUtteranceCount	integer	Die Mindestanzahl der Äußerungen, die zum Trainieren eines Stimmmodells mit diesem Rezept erforderlich ist.
modelLocales	string[]	Das Gebietsschema, das ein Sprachmodell mit diesem Rezept sprechen kann. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachtext 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 Stiltrainingssatz abrufen.
version	string	Rezeptversion

Status

Status einer Ressource.

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