Freigeben über

Models - List Base Models

Dienst:
Azure AI Services
API-Version:
v3.2-preview.2

Ruft die Liste der Basismodelle für das authentifizierte Abonnement ab.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base
Mit optionalen Parametern: 
GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

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).
filter
 query

string

Ein Filterausdruck zum Auswählen einer Teilmenge der verfügbaren Basismodelle.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=status eq 'NotStarted' or status eq 'Running'
skip
 query

integer (int32)

Anzahl der Datasets, die übersprungen werden.
top
 query

integer (int32)

Die Anzahl der Datasets, die nach dem Überspringen eingeschlossen werden.

Antworten

Name Typ Beschreibung
200 OK

PaginatedBaseModels

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 all english base models

Beispielanforderung

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Beispiel für eine Antwort

Statuscode:
200 
{
  "values": [
    {
      "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
PaginatedBaseModels

PaginatedBaseModels
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.
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
Language

Ein Sprachdatensatz.
Acoustic

Ein akustisches Dataset.
Pronunciation

Ein Aussprache-Dataset.
AudioFiles

Ein Dataset für Audiodateien.
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

DetailedErrorCode

Enumeration

DetailedErrorCode

Wert Beschreibung
InvalidParameterValue

Ungültiger Parameterwert.
InvalidRequestBodyFormat

Ungültiges Anforderungstextformat.
EmptyRequest

Leere Anforderung.
MissingInputRecords

Fehlende Eingabedatensätze.
InvalidDocument

Ungültiges Dokument.
ModelVersionIncorrect

Modellversion falsch.
InvalidDocumentBatch

Ungültiger Dokumentbatch.
UnsupportedLanguageCode

Nicht unterstützter Sprachcode.
DataImportFailed

Fehler beim Datenimport.
InUseViolation

Verletzung des Einsatzes.
InvalidLocale

Ungültiges Gebietsschema.
InvalidBaseModel

Ungültiges Basismodell.
InvalidAdaptationMapping

Ungültige Anpassungszuordnung.
InvalidDataset

Ungültiges Dataset.
InvalidTest

Ungültiger Test.
FailedDataset

Fehler beim Dataset.
InvalidModel

Ungültiges Modell.
InvalidTranscription

Ungültige Transkription.
InvalidPayload

Ungültige Nutzlast.
InvalidParameter

Ungültiger Parameter.
EndpointWithoutLogging

Endpunkt ohne Protokollierung.
InvalidPermissions

Ungültige Berechtigungen.
InvalidPrerequisite

Ungültige Voraussetzung.
InvalidProductId

Ungültige Produkt-ID.
InvalidSubscription

Ungültiges Abonnement.
InvalidProject

Ungültiges Projekt.
InvalidProjectKind

Ungültige Projektart.
InvalidRecordingsUri

Ungültiger Aufzeichnungs-URI.
OnlyOneOfUrlsOrContainerOrDataset

Nur eine url oder ein Container oder Dataset.
ExceededNumberOfRecordingsUris

Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
ModelMismatch

Modellkonflikt.
ProjectGenderMismatch

Projekt Gender-Mismatch.
ModelDeprecated

Das Modell ist veraltet.
ModelExists

Das Modell ist vorhanden.
ModelNotDeployable

Das Modell kann nicht bereitgestellt werden.
EndpointNotUpdatable

Endpunkt nicht aktualisierbar.
SingleDefaultEndpoint

Einzelner Standardendpunkt.
EndpointCannotBeDefault

Der Endpunkt kann nicht standardmäßig sein.
InvalidModelUri

Ungültiger Modell-URI.
SubscriptionNotFound

Das Abonnement wurde nicht gefunden.
QuotaViolation

Kontingentverletzung.
UnsupportedDelta

Nicht unterstütztes Delta.
UnsupportedFilter

Nicht unterstützter Filter.
UnsupportedPagination

Nicht unterstützte Paginierung.
UnsupportedDynamicConfiguration

Nicht unterstützte dynamische Konfiguration.
UnsupportedOrderBy

Nicht unterstützte Reihenfolge nach.
NoUtf8WithBom

Kein utf8 mit bom.
ModelDeploymentNotCompleteState

Der Status der Modellbereitstellung ist nicht abgeschlossen.
SkuLimitsExist

Sku-Grenzwerte sind vorhanden.
DeployingFailedModel

Fehler beim Bereitstellen des Modells.
UnsupportedTimeRange

Nicht unterstützter Zeitraum.
InvalidLogDate

Ungültiges Protokolldatum.
InvalidLogId

Ungültige Protokoll-ID.
InvalidLogStartTime

Ungültige Startzeit des Protokolls.
InvalidLogEndTime

Ungültige Protokollendzeit.
InvalidTopForLogs

Ungültiger Anfang für Protokolle.
InvalidSkipTokenForLogs

Ungültiges Skip-Token für Protokolle.
DeleteNotAllowed

Löschen nicht zulässig.
Forbidden

Verboten.
DeployNotAllowed

Bereitstellen nicht zulässig.
UnexpectedError

Unerwarteter Fehler.
InvalidCollection

Ungültige Auflistung.
InvalidCallbackUri

Ungültiger Rückruf-URI.
InvalidSasValidityDuration

Ungültige Gültigkeitsdauer für sas.
InaccessibleCustomerStorage

Nicht zugänglicher Kundenspeicher.
UnsupportedClassBasedAdaptation

Nicht unterstützte klassenbasierte Anpassung.
InvalidWebHookEventKind

Ungültiger Web hook-Ereignistyp.
InvalidTimeToLive

Ungültige Zeit für live.
InvalidSourceAzureResourceId

Ungültige Azure-Quellressourcen-ID.
ModelCopyOperationExists

Der Modellkopievorgang ist vorhanden.

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
InvalidRequest

Stellt den ungültigen Anforderungsfehlercode dar.
InvalidArgument

Stellt den fehlercode für ungültiges Argument dar.
InternalServerError

Stellt den internen Fehlercode des Servers dar.
ServiceUnavailable

Stellt den dienst nicht verfügbaren Fehlercode dar.
NotFound

Stellt den nicht gefundenen Fehlercode dar.
PipelineError

Stellt den Pipelinefehlerfehlercode dar.
Conflict

Stellt den Konfliktfehlercode dar.
InternalCommunicationFailed

Fehlercode für die interne Kommunikation.
Forbidden

Stellt den verbotenen Fehlercode dar.
NotAllowed

Stellt den nicht zulässigen Fehlercode dar.
Unauthorized

Stellt den nicht autorisierten Fehlercode dar.
UnsupportedMediaType

Stellt den Fehlercode für den nicht unterstützten Medientyp dar.
TooManyRequests

Stellt den Fehlercode für zu viele Anforderungen dar.
UnprocessableEntity

Stellt den nicht verarbeiteten Entitätsfehlercode 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
Lexical

Das Modell stellt die Transkriptionsausgabe ohne Formatierung bereit.
Display

Das Modell unterstützt die Ausgabe oder Endpunkte der Anzeigeformatierung.

PaginatedBaseModels

Objekt

PaginatedBaseModels

Name Typ Beschreibung
@nextLink

string (uri)

Eine Verknüpfung mit den nächsten Auslagerungsergebnissen, wenn weitere Entitäten verfügbar sind; andernfalls NULL.
values

BaseModel[]

Eine Liste der Entitäten, die entweder durch die übergebenen Abfrageparameter "skip" und "top" oder deren Standardwerte beschränkt sind.

Wenn Sie eine Liste mithilfe von Paginierung durchlaufen und Entitäten parallel löschen, werden einige Entitäten in den Ergebnissen übersprungen. Es wird empfohlen, eine Liste auf dem Client zu erstellen und nach dem Abrufen der vollständigen Liste zu löschen.

Status

Enumeration

Status

Wert Beschreibung
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.
Failed

Fehler beim vorgang mit langer Ausführung.