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)	Die Anzahl der Datasets, die nach dem Überspringen eingeschlossen werden.

Antworten

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

Name

Typ

Beschreibung

200 OK

PaginatedCustomModels

OKAY

Header

Retry-After: integer

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 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	Fehlercode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	PaginatedCustomModels
Status	Status

CustomModel

Objekt

CustomModel

Name	Typ	Beschreibung
baseModel	EntityReference	EntityReference
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).
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 zulässiger Einträge beträgt 10.
datasets	EntityReference[]	Datasets, die für die Anpassung verwendet werden.
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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Das Gebietsschema der enthaltenen Daten.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Status der API
text	string	Der Text, der zum Anpassen dieses Sprachmodells verwendet wird.

CustomModelDeprecationDates

Objekt

CustomModelDeprecationDates

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

CustomModelFeatures

Objekt

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

Objekt

CustomModelLinks

Name	Typ	Beschreibung
copy	string (uri)	Der Speicherort für die Modellkopieaktion. Weitere Informationen finden Sie unter Operation "Models_Copy".
copyTo	string (uri)	Der Speicherort für die veraltete Modellkopienaktion. Weitere Informationen finden Sie unter Operation "Models_CopyTo".
files	string (uri)	Der Speicherort zum Abrufen aller Dateien dieser Entität. Weitere Informationen finden Sie unter Operation "Models_ListFiles".
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".

CustomModelProperties

Objekt

CustomModelProperties

Name	Typ	Beschreibung
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Die Gewichtung des benutzerdefinierten Modells zwischen 1 (1% benutzerdefiniertem 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 nach dem erfolgreichen Senden der E-Mail entfernt.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Vom Modell unterstützte Features.

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.

EntityError

Objekt

EntityError

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

EntityReference

Objekt

EntityReference

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

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.

PaginatedCustomModels

Objekt

PaginatedCustomModels

Name	Typ	Beschreibung
@nextLink	string (uri)	Eine Verknüpfung mit den nächsten Auslagerungsergebnissen, wenn weitere Entitäten verfügbar sind; andernfalls NULL.
values	CustomModel[]	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.

Name

Typ

Beschreibung

@nextLink

string (uri)

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

values

CustomModel[]

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
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 - 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