Models - Get Base Model

Referenz

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

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

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Der Bezeichner des Basismodells.

Antworten

Name	Typ	Beschreibung
200 OK	BaseModel	OKAY
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Stellen Sie hier Ihren kognitiven Leistungskontoschlüssel bereit.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken von JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Get a base model

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

Beispiel für eine Antwort

Statuscode:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

Definitionen

Name	Beschreibung
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Fehler
ErrorCode	Fehlercode
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Status

BaseModel

Objekt

BaseModel

Name	Typ	Beschreibung
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	Die Beschreibung des Objekts.
displayName	string minLength: 1	Der Anzeigename des Objekts.
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).
links	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	Das Gebietsschema der enthaltenen Daten.
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Status der API

BaseModelDeprecationDates

Objekt

BaseModelDeprecationDates

Name	Typ	Beschreibung
adaptationDateTime	string (date-time)	Das Datum, an dem die Anpassung veraltet ist.
transcriptionDateTime	string (date-time)	Das Datum, an dem die Transkription veraltet ist.

BaseModelFeatures

Objekt

BaseModelFeatures

Name	Typ	Beschreibung
supportedOutputFormats	OutputFormatType[]	Unterstützte Ausgabeformate.
supportsAdaptationsWith	DatasetKind[]	Unterstützte Datasettypen zum Anpassen des Modells.
supportsEndpoints	boolean	Ein Wert, der angibt, ob die Erstellung von Endpunkten für die Livetranskription unterstützt wird.
supportsTranscriptions	boolean	Ein Wert, der angibt, ob die Batchtranskription unterstützt wird.
supportsTranscriptionsOnSpeechContainers	boolean	Ein Wert, der angibt, ob dieses Modell für die Transkription im Sprachcontainer verwendet werden kann. Dieses Feature kann in vorhandenen Modellen hinzugefügt werden, wenn es im Sprachcontainer verwendet werden kann.

BaseModelLinks

Objekt

BaseModelLinks

Name	Typ	Beschreibung
manifest	string (uri)	Der Speicherort zum Abrufen eines Manifests für dieses Modell, das im lokalen Container verwendet werden soll. Weitere Informationen finden Sie unter Operation "Models_GetCustomModelManifest".

BaseModelProperties

Objekt

BaseModelProperties

Name	Typ	Beschreibung
chargeForAdaptation	boolean	Ein Wert, der angibt, ob die Modellanpassung belastet wird.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Vom Modell unterstützte Features.

DatasetKind

Enumeration

DatasetKind

Wert	Beschreibung
Acoustic	Ein akustisches Dataset.
AudioFiles	Ein Dataset für Audiodateien.
Language	Ein Sprachdatensatz.
LanguageMarkdown	Ein Sprachmarkdown-Dataset.
OutputFormatting	Dataset mit Regeln zum Anpassen umgekehrter Textnormalisierung, Groß-/Kleinschreibung, Reformierung, Profanität und definiert auch Tests für die Datasetvalidierung
Pronunciation	Ein Aussprache-Dataset.

DetailedErrorCode

Enumeration

DetailedErrorCode

Wert	Beschreibung
DataImportFailed	Fehler beim Datenimport.
DeleteNotAllowed	Löschen nicht zulässig.
DeployNotAllowed	Bereitstellen nicht zulässig.
DeployingFailedModel	Fehler beim Bereitstellen des Modells.
EmptyRequest	Leere Anforderung.
EndpointCannotBeDefault	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
FailedDataset	Fehler beim Dataset.
Forbidden	Verboten.
InUseViolation	Verletzung des Einsatzes.
InaccessibleCustomerStorage	Nicht zugänglicher Kundenspeicher.
InvalidAdaptationMapping	Ungültige Anpassungszuordnung.
InvalidBaseModel	Ungültiges Basismodell.
InvalidCallbackUri	Ungültiger Rückruf-URI.
InvalidCollection	Ungültige Auflistung.
InvalidDataset	Ungültiges Dataset.
InvalidDocument	Ungültiges Dokument.
InvalidDocumentBatch	Ungültiger Dokumentbatch.
InvalidLocale	Ungültiges Gebietsschema.
InvalidLogDate	Ungültiges Protokolldatum.
InvalidLogEndTime	Ungültige Protokollendzeit.
InvalidLogId	Ungültige Protokoll-ID.
InvalidLogStartTime	Ungültige Startzeit des Protokolls.
InvalidModel	Ungültiges Modell.
InvalidModelUri	Ungültiger Modell-URI.
InvalidParameter	Ungültiger Parameter.
InvalidParameterValue	Ungültiger Parameterwert.
InvalidPayload	Ungültige Nutzlast.
InvalidPermissions	Ungültige Berechtigungen.
InvalidPrerequisite	Ungültige Voraussetzung.
InvalidProductId	Ungültige Produkt-ID.
InvalidProject	Ungültiges Projekt.
InvalidProjectKind	Ungültige Projektart.
InvalidRecordingsUri	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	Ungültige Gültigkeitsdauer für sas.
InvalidSkipTokenForLogs	Ungültiges Skip-Token für Protokolle.
InvalidSourceAzureResourceId	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	Ungültiges Abonnement.
InvalidTest	Ungültiger Test.
InvalidTimeToLive	Ungültige Zeit für live.
InvalidTopForLogs	Ungültiger Anfang für Protokolle.
InvalidTranscription	Ungültige Transkription.
InvalidWebHookEventKind	Ungültiger Web hook-Ereignistyp.
MissingInputRecords	Fehlende Eingabedatensätze.
ModelCopyOperationExists	Der Modellkopievorgang ist vorhanden.
ModelDeploymentNotCompleteState	Der Status der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	Das Modell ist veraltet.
ModelExists	Das Modell ist vorhanden.
ModelMismatch	Modellkonflikt.
ModelNotDeployable	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	Modellversion falsch.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Nur eine url oder ein Container oder Dataset.
ProjectGenderMismatch	Project gender mismatch.
QuotaViolation	Kontingentverletzung.
SingleDefaultEndpoint	Einzelner Standardendpunkt.
SkuLimitsExist	Sku-Grenzwerte sind vorhanden.
SubscriptionNotFound	Das Abonnement wurde nicht gefunden.
UnexpectedError	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	Nicht unterstützter Filter.
UnsupportedLanguageCode	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	Nicht unterstützte Paginierung.
UnsupportedTimeRange	Nicht unterstützter Zeitraum.

Error

Objekt

Fehler

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode Fehlercodes auf hoher Ebene.
details	Error[]	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

ErrorCode

Enumeration

Fehlercode

Wert	Beschreibung
Conflict	Stellt den Konfliktfehlercode dar.
Forbidden	Stellt den verbotenen Fehlercode dar.
InternalCommunicationFailed	Fehlercode für die interne Kommunikation.
InternalServerError	Stellt den internen Fehlercode des Servers dar.
InvalidArgument	Stellt den fehlercode für ungültiges Argument dar.
InvalidRequest	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	Stellt den nicht zulässigen Fehlercode dar.
NotFound	Stellt den nicht gefundenen Fehlercode dar.
PipelineError	Stellt den Pipelinefehlerfehlercode dar.
ServiceUnavailable	Stellt den dienst nicht verfügbaren Fehlercode dar.
TooManyRequests	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	Stellt den nicht verarbeiteten Entitätsfehlercode dar.
UnsupportedMediaType	Stellt den Fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Objekt

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercode-Enumeration.
details	object	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

OutputFormatType

Enumeration

OutputFormatType

Wert	Beschreibung
Display	Das Modell unterstützt die Ausgabe oder Endpunkte der Anzeigeformatierung.
Lexical	Das Modell stellt die Transkriptionsausgabe ohne Formatierung bereit.

Status

Enumeration

Status

Wert	Beschreibung
Failed	Fehler beim vorgang mit langer Ausführung.
NotStarted	Der lange ausgeführte Vorgang wurde noch nicht gestartet.
Running	Der lange ausgeführte Vorgang wird zurzeit verarbeitet.
Succeeded	Der lange ausgeführte Vorgang wurde erfolgreich abgeschlossen.

Freigeben über

Models - Get Base Model

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Get a base model

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status

Zusätzliche Ressourcen