Freigeben über

Models - Get

  • Referenz
Dienst:
Azure AI Services
API-Version:
2024-02-01-preview

Ruft das Modell ab, das durch die angegebene ID identifiziert wird.

GET {endpoint}/customvoice/models/{id}?api-version=2024-02-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

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Die ID der Ressource.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Ocp-Apim-Subscription-Key True

string

Geben Sie hier Ihren Sprachressourcenschlüssel an.

Antworten

Name Typ Beschreibung
200 OK

Model

Erfolg
Other Status Codes

ErrorResponse

Fehler.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Sprachressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Get a model

Beispielanforderung

GET {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview

Beispiel für eine Antwort

Statuscode:
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 der obersten Ebene 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 einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.
ErrorCode

Fehlercode der obersten Ebene
ErrorResponse

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

Interner 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 erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
Model

Model-Objekt
ModelFailureReason

Grund für Modellschulungsfehler
ModelProperties

Modelleigenschaften
PresetStyleItem

Voreingestellte Stile, die vom Rezept unterstützt werden. Das VoIP-Modell kann diese Stile ohne Formatvorlagenschulung unterstützen.
Recipe

Rezept für das Modellbau. Verschiedene Rezepte haben unterschiedliche Funktionen.
Status

Status einer Ressource.

Error

Objekt

Fehler der obersten Ebene 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 einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.

Name Typ Beschreibung
code

ErrorCode

Fehlercode der obersten Ebene
details

Error[]

Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innererror

InnerError

Interner 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 erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
message

string

Fehlermeldung auf oberster Ebene.
target

string

Die Quelle des Fehlers. Dies wäre z. B. "Modell" oder "Modell-ID" im Falle eines ungültigen Modells.

ErrorCode

Enumeration

Fehlercode der obersten Ebene

Wert Beschreibung
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Die Fehlerantwort folgt den Microsoft Azure REST-API-Richtlinien, 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 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 einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.

InnerError

Objekt

Interner 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 erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).

Name Typ Beschreibung
code

string

Detaillierter Fehlercode zur Diagnose.
innererror

InnerError

Interner 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 erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
message

string

Detaillierte Fehlermeldung.
target

string

Die Quelle des Fehlers. Dies wäre z. B. "Modell" oder "Modell-ID" im Falle eines ungültigen Modells.

Model

Objekt

Model-Objekt

Name Typ Beschreibung
consentId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Ressourcen-ID
createdDateTime

string (date-time)

Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description

string

Modellbeschreibung
engineVersion

string

Modulversion. Aktualisieren Sie diese Version, um die neueste Fehlerbehebung für die Aussprache zu erhalten.
id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Ressourcen-ID
lastActionDateTime

string (date-time)

Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-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. Hier finden Sie den Text zur Sprachgebietsschemaliste https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Ressourcen-ID
properties

ModelProperties

Modelleigenschaften
recipe

Recipe

Rezept für das Modellbau. Verschiedene Rezepte haben unterschiedliche Funktionen.
status

Status

Status einer Ressource.
trainingSetId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Ressourcen-ID
voiceName

string

minLength: 1

Sprachname

ModelFailureReason

Enumeration

Grund für Modellschulungsfehler

Wert Beschreibung
InaccessibleCustomerStorage

Der Kunde verwendet Bring Your Own Storage in Speech Account. Der Speicher ist jetzt jedoch nicht verfügbar. Bitte überprüfen Sie Dokument.
Internal

Benutzerdefinierter VoIP-Dienstfehler.
SpeakerVerificationFailed

Die Zustimmungs- und Schulungsaudio stammen nicht vom gleichen Lautsprecher.
TerminateByUser

Der Kunde hat die Modellschulung abgebrochen.

ModelProperties

Objekt

Modelleigenschaften

Name Typ Beschreibung
failureReason

ModelFailureReason

Grund für Modellschulungsfehler
presetStyles

string[]

Voreingestellte Formatvorlagen dieses Modells.
styleTrainingSetIds

object

Angepasste Stile und zugeordnete Schulungssätze.
voiceStyles

string[]

Alle von diesem Modell unterstützten Formatvorlagen.

PresetStyleItem

Objekt

Voreingestellte Stile, die vom Rezept unterstützt werden. Das VoIP-Modell kann diese Stile ohne Formatvorlagenschulung unterstützen.

Name Typ Beschreibung
female

string[]

Voreingestellte Stile, die im weiblichen Sprachmodell unterstützt werden.
male

string[]

Voreingestellte Formatvorlagen, die für das männliche Sprachmodell unterstützt werden.

Recipe

Objekt

Rezept für das Modellbau. Verschiedene Rezepte haben unterschiedliche Funktionen.

Name Typ Beschreibung
datasetLocales

string[]

Das Gebietsschema des Schulungsdatensatzes. Gebietsschemacode folgt BCP-47. Hier finden Sie den Text zur Sprachgebietsschemaliste https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description

string

Rezeptbeschreibung
kind

string

Rezeptart
maxCustomStyleNum

integer (int32)

Maximale angepasste Formatnummer, die in einem VoIP-Modell unterstützt wird.
minStyleUtteranceCount

integer (int32)

Die Mindestanzahl der Äußerungen, die erforderlich sind, um jede angepasste Formatvorlage zu trainieren.
minUtteranceCount

integer (int32)

Die Mindestanzahl der Äußerungen, die zum Trainieren eines Sprachmodells mit diesem Rezept erforderlich sind.
modelLocales

string[]

Das Gebietsschema, das ein Sprachmodell mit diesem Rezept sprechen kann. Gebietsschemacode folgt BCP-47. Hier finden Sie den Text zur Sprachgebietsschemaliste https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles

<string,  PresetStyleItem>

Voreingestellte Formatvorlagen, die von diesem Rezept pro Gebietsschema unterstützt werden. Sie können diese Stile ohne Formatvorlagenschulungssatz abrufen.
version

string

Rezeptversion

Status

Enumeration

Status einer Ressource.

Wert Beschreibung
Disabled
Disabling
Failed
NotStarted
Running
Succeeded