Datasets - List

Dienst:: Azure AI Services

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

Ruft eine Liste der Datasets für das authentifizierte Abonnement ab.

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

Mit optionalen Parametern:

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?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 Datasets. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind. - 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=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'`
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	PaginatedDatasets	OKAY Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

PaginatedDatasets

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

Get all datasets

Get all acoustic datasets

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?skip=0&top=10&filter=kind%20eq%20'Acoustic'

Beispiel für eine Antwort

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    }
  ]
}

Get all datasets

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Beispiel für eine Antwort

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c",
      "kind": "Language",
      "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language dataset"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definitionen

Name	Beschreibung
Dataset	Datensatz
DatasetKind	DatasetKind
DatasetLinks	DatasetLinks
DatasetProperties	DatasetProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	Fehlercode
InnerError	InnerError
PaginatedDatasets	PaginatedDatasets
Status	Status
TextNormalizationKind	TextNormalizationKind

Dataset

Objekt

Datensatz

Name	Typ	Beschreibung
contentUrl	string (uri)	Die URL der Daten für das Dataset.
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.
description	string	Die Beschreibung des Objekts.
displayName	string minLength: 1	Der Anzeigename des Objekts.
kind	DatasetKind	DatasetKind Datentyp des Datenimports.
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	DatasetLinks	DatasetLinks
locale	string minLength: 1	Das Gebietsschema der enthaltenen Daten.
project	EntityReference	EntityReference
properties	DatasetProperties	DatasetProperties
self	string (uri)	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Status der API

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

DatasetLinks

Objekt

DatasetLinks

Name	Typ	Beschreibung
commitBlocks	string (uri)	Der Speicherort zum Commit der Liste der Blöcke beim Hochladen eines Datasets mithilfe von Blöcken. Weitere Informationen finden Sie unter Operation "Datasets_CommitBlocks".
files	string (uri)	Der Speicherort zum Abrufen aller Dateien dieser Entität. Weitere Informationen finden Sie unter Operation "Datasets_ListFiles".
listBlocks	string (uri)	Der Speicherort zum Auflisten der bereits hochgeladenen Blöcke dieser Entität beim Hochladen eines Datasets mit Blöcken. Weitere Informationen finden Sie unter Operation "Datasets_GetBlocks".
uploadBlocks	string (uri)	Der Speicherort zum Hochladen von Blöcken beim Hochladen eines Datasets mithilfe von Blöcken. Weitere Informationen finden Sie unter Operation "Datasets_UploadBlock".

DatasetProperties

Objekt

DatasetProperties

Name	Typ	Beschreibung
acceptedLineCount	integer (int32)	Die Anzahl der Zeilen, die für diesen Datensatz akzeptiert werden.
duration	string	Die Gesamtdauer der Datasets, wenn sie Audiodateien enthält. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).
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
rejectedLineCount	integer (int32)	Die Anzahl der für diesen Datensatz abgelehnten Zeilen.
textNormalizationKind	TextNormalizationKind	TextNormalizationKind Die Art der Textnormalisierung.

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.

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

PaginatedDatasets

Objekt

PaginatedDatasets

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

Dataset[]

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.

TextNormalizationKind

Enumeration

TextNormalizationKind

Wert	Beschreibung
Default	Standardtextnormalisierung (z. B. "2 bis 3" wird in en-USdurch "zwei bis drei" ersetzt).
None	Auf den Eingabetext wird keine Textnormalisierung angewendet. Dies ist eine Außerkraftsetzungsoption, die nur verwendet werden soll, wenn Text vor dem Upload normalisiert wird.