Base Models - List

Dienst:

Azure AI Services

API-Version:

2024-02-01-preview

Ruft eine Liste der Basismodelle ab.

GET {endpoint}/customvoice/basemodels?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).
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	BaseModel[]	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 base models

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "name": "PhoenixV2Neural",
      "description": "Phonenix V2 base model",
      "releaseDateTime": "2023-12-01T00:00:00.000Z",
      "capabilities": [
        "PersonalVoice"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
BaseModel	Basismodell
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).
ModelCapability	Modellfunktion

BaseModel

Objekt

Basismodell

Name	Typ	Beschreibung
capabilities	ModelCapability[]	Funktionen des Basismodells
description	string
expirationDateTime	string (date-time)	Der Zeitstempel, wenn der TTS-Dienst die Bereitstellung dieses Basismodells beendet. 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).
name	string minLength: 1
releaseDateTime	string (date-time)	Der Stempel, als das Basismodell freigegeben 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).

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.

ModelCapability

Enumeration

Modellfunktion

Wert	Beschreibung
PersonalVoice