Models - List Custom Models

Referenz

Dienst:: Azure AI Services

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

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

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

Mit optionalen Parametern:

GET {endpoint}/speechtotext/v3.2-preview.2/models?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 Modelle. `- 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	Anzahl der Datasets, die nach dem Überspringen eingeschlossen werden.

Antworten

Name	Typ	Beschreibung
200 OK	PaginatedCustomModels	OK Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

PaginatedCustomModels

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem 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 models in state 'Running'

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models?skip=0&top=2&filter=status%20eq%20'Running'

Beispiel für eine Antwort

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language model",
      "description": "This is a language model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definitionen

Name	Beschreibung
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	PaginatedCustomModels
Status	Status

CustomModel

Name	Typ	Beschreibung
baseModel	EntityReference	EntityReference
createdDateTime	string	Der Zeitstempel, zu 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).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
datasets	EntityReference[]	Datasets, die für die Anpassung verwendet werden.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Anzeigename des Objekts.
lastActionDateTime	string	Der Zeitstempel, bei dem der 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).
links	CustomModelLinks	CustomModelLinks
locale	string	Das Gebietsschema der enthaltenen Daten.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Zustands der API
text	string	Der Text, der zum Anpassen dieses Sprachmodells verwendet wird.

CustomModelDeprecationDates

Name	Typ	Beschreibung
transcriptionDateTime	string	Das Datum, an dem die Transkription veraltet ist.

CustomModelFeatures

Name	Typ	Beschreibung
supportedOutputFormats	OutputFormatType[]	Unterstützte Ausgabeformate.
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.

CustomModelLinks

Name	Typ	Beschreibung
copy	string	Der Speicherort der Modellkopieraktion. Weitere Informationen finden Sie unter Vorgang „Models_Copy“.
copyTo	string	Der Speicherort für die Kopieraktion des veralteten Modells. Weitere Informationen finden Sie unter Vorgang „Models_CopyTo“.
files	string	Der Speicherort, an dem alle Dateien dieser Entität abgerufen werden sollen. Weitere Informationen finden Sie unter Vorgang "Models_ListFiles".
manifest	string	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".

CustomModelProperties

Name	Typ	Beschreibung
customModelWeightPercent	integer	Die Gewichtung des benutzerdefinierten Modells zwischen 1 (1 % benutzerdefiniertes Modell und 99 % Basismodell) und 100 (100 % benutzerdefiniertes Modell und 0 % Basismodell). Wenn diese Eigenschaft nicht festgelegt ist, wählt der Dienst einen geeigneten Wert aus (rufen Sie das Modell ab, um die ausgewählte Gewichtung abzurufen). Beginnen Sie, ohne diese Eigenschaft zu verwenden. Wählen Sie bei Bedarf eine größere (oder kleinere) Gewichtung aus, um die Auswirkungen des benutzerdefinierten Modells zu erhöhen (oder zu verringern).
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird entfernt, nachdem die E-Mail erfolgreich gesendet wurde.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Vom Modell unterstützte Features.

DetailedErrorCode

Name	Typ	Beschreibung
DataImportFailed	string	Fehler beim Datenimport.
DeleteNotAllowed	string	Löschen nicht zulässig.
DeployNotAllowed	string	Bereitstellen ist nicht zulässig.
DeployingFailedModel	string	Bereitstellen eines fehlerhaften Modells.
EmptyRequest	string	Leere Anforderung.
EndpointCannotBeDefault	string	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	string	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	string	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	string	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
FailedDataset	string	Fehlgeschlagenes Dataset.
Forbidden	string	Unzulässig.
InUseViolation	string	Bei verwendungsverstößen.
InaccessibleCustomerStorage	string	Auf den Kundenspeicher kann nicht zugegriffen werden.
InvalidAdaptationMapping	string	Ungültige Anpassungszuordnung.
InvalidBaseModel	string	Ungültiges Basismodell.
InvalidCallbackUri	string	Ungültiger Rückruf-URI.
InvalidCollection	string	Ungültige Auflistung.
InvalidDataset	string	Ungültiges Dataset.
InvalidDocument	string	Ungültiges Dokument.
InvalidDocumentBatch	string	Ungültiger Dokumentbatch.
InvalidLocale	string	Ungültiges Gebietsschema.
InvalidLogDate	string	Ungültiges Protokolldatum.
InvalidLogEndTime	string	Ungültige Protokollendzeit.
InvalidLogId	string	Ungültige Protokoll-ID.
InvalidLogStartTime	string	Ungültige Protokollstartzeit.
InvalidModel	string	Ungültiges Modell.
InvalidModelUri	string	Ungültiger Modell-URI.
InvalidParameter	string	Ungültiger Parameter.
InvalidParameterValue	string	Ungültiger Parameterwert.
InvalidPayload	string	Ungültige Nutzlast.
InvalidPermissions	string	Ungültige Berechtigungen.
InvalidPrerequisite	string	Ungültige Voraussetzung.
InvalidProductId	string	Ungültige Produkt-ID.
InvalidProject	string	Ungültiges Projekt.
InvalidProjectKind	string	Ungültige Projektart.
InvalidRecordingsUri	string	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	string	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	string	Ungültige SAS-Gültigkeitsdauer.
InvalidSkipTokenForLogs	string	Ungültiges Überspringen des Tokens für Protokolle.
InvalidSourceAzureResourceId	string	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	string	Ungültiges Abonnement.
InvalidTest	string	Ungültiger Test.
InvalidTimeToLive	string	Ungültige Gültigkeitsdauer.
InvalidTopForLogs	string	Ungültiger Anfang für Protokolle.
InvalidTranscription	string	Ungültige Transkription.
InvalidWebHookEventKind	string	Ungültige Webhookereignisart.
MissingInputRecords	string	Fehlende Eingabedatensätze.
ModelCopyOperationExists	string	Modellkopiervorgang ist vorhanden.
ModelDeploymentNotCompleteState	string	Der Status der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	string	Das Modell ist veraltet.
ModelExists	string	Das Modell ist vorhanden.
ModelMismatch	string	Modellkonflikt.
ModelNotDeployable	string	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	string	Modellversion falsch.
NoUtf8WithBom	string	Kein utf8 mit bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Nur eine der URLs, container oder datasets.
ProjectGenderMismatch	string	Projizieren von Geschlechtskonflikten.
QuotaViolation	string	Kontingentverletzung.
SingleDefaultEndpoint	string	Einzelner Standardendpunkt.
SkuLimitsExist	string	SKU-Grenzwerte sind vorhanden.
SubscriptionNotFound	string	Das Abonnement wurde nicht gefunden.
UnexpectedError	string	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	string	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	string	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	string	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	string	Nicht unterstützter Filter.
UnsupportedLanguageCode	string	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	string	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	string	Nicht unterstützte Paginierung.
UnsupportedTimeRange	string	Nicht unterstützter Zeitbereich.

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

EntityReference

Name	Typ	Beschreibung
self	string	Der Speicherort der Entität, auf die verwiesen wird.

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Allgemeine Fehlercodes.
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

Name	Typ	Beschreibung
Conflict	string	Stellt den Konfliktfehlercode dar.
Forbidden	string	Stellt den unzulässigen Fehlercode dar.
InternalCommunicationFailed	string	Stellt den Fehlercode für interne Kommunikationsfehler dar.
InternalServerError	string	Stellt den Fehlercode des internen Servers dar.
InvalidArgument	string	Stellt den Fehlercode des ungültigen Arguments dar.
InvalidRequest	string	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	string	Stellt den nicht zulässigen Fehlercode dar.
NotFound	string	Stellt den Fehlercode nicht gefunden dar.
PipelineError	string	Stellt den Fehlercode für die Pipeline dar.
ServiceUnavailable	string	Stellt den Nicht verfügbaren Fehlercode des Diensts dar.
TooManyRequests	string	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	string	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	string	Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.
UnsupportedMediaType	string	Stellt den fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercodeenume.
details	object	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

OutputFormatType

Name	Typ	Beschreibung
Display	string	Das Modell unterstützt die Ausgabe oder Endpunkte von Transkriptionen zur Anzeigeformatierung.
Lexical	string	Das Modell stellt die Transkriptionsausgabe ohne Formatierung bereit.

PaginatedCustomModels

Name	Typ	Beschreibung
@nextLink	string	Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Entitäten verfügbar sind; andernfalls NULL.
values	CustomModel[]	Eine Liste von Entitäten, die entweder durch die übergebenen Abfrageparameter "skip" und "top" oder deren Standardwerte beschränkt sind. Beim Durchlaufen einer Liste mit Paginierung und parallelem Löschen von Entitäten 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.

Name

Typ

Beschreibung

@nextLink

string

Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Entitäten verfügbar sind; andernfalls NULL.

values

CustomModel[]

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

Beim Durchlaufen einer Liste mit Paginierung und parallelem Löschen von Entitäten 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

Name	Typ	Beschreibung
Failed	string	Der Vorgang mit langer Ausführungsdauer ist fehlgeschlagen.
NotStarted	string	Der lang andauernde Vorgang wurde noch nicht gestartet.
Running	string	Der Vorgang mit langer Ausführungszeit wird derzeit verarbeitet.
Succeeded	string	Der lang andauernde Vorgang wurde erfolgreich abgeschlossen.

Freigeben über

Models - List Custom Models

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Get all models in state 'Running'

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

PaginatedCustomModels

Status

Zusätzliche Ressourcen