Evaluations - List Files

Referenz

Dienst:: Azure AI Services

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

Ruft die Dateien der Auswertung ab, die durch die angegebene ID identifiziert wird.

GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}/files

Mit optionalen Parametern:

GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&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).
id	path	True	string (uuid)	Der Bezeichner der Auswertung.
filter	query		string	Ein Filterausdruck zum Auswählen einer Teilmenge der verfügbaren Dateien. `- Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav' and kind eq 'Audio'`
sasValidityInSeconds	query		integer (int32)	Die Dauer in Sekunden, die eine SAS-URL gültig sein soll. Die Standarddauer beträgt 12 Stunden. Bei Verwendung von BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): Ein Wert von 0 bedeutet, dass ein einfacher BLOB-URI ohne SAS-Token generiert wird.
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	PaginatedFiles	OKAY Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

PaginatedFiles

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 files

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?sasValidityInSeconds=120&skip=0&top=2

Beispiel für eine Antwort

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a",
      "name": "mywavefile1.wav.model1_score.json",
      "kind": "EvaluationDetails",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.model2_score.json",
      "kind": "EvaluationDetails",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2"
}

Definitionen

Name	Beschreibung
DetailedErrorCode	DetailedErrorCode
Error	Fehler
ErrorCode	Fehlercode
File	Datei
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError
PaginatedFiles	PaginatedFiles

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.

File

Objekt

Datei

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Die Erstellungszeit dieser Datei. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert (siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind	FileKind	FileKind Datentyp.
links	FileLinks	FileLinks
name	string	Der Name dieser Datei.
properties	FileProperties	FileProperties
self	string (uri)	Der Speicherort dieser Entität.

FileKind

Enumeration

FileKind

Wert	Beschreibung
AcousticDataArchive	Der Datentyp ist ein akustisches Datenarchiv.
AcousticDataTranscriptionV2	Der Datentyp ist eine akustische Datentranskription v2.
Audio	Der Typ der Daten ist Audio.
DatasetReport	Der Datentyp ist der Datasetbericht.
EvaluationDetails	Die Art der Daten ist Auswertungsdetails.
LanguageData	Der Datentyp ist Sprachdaten.
ModelReport	Der Typ der Daten ist der Modellbericht.
OutputFormattingData	Der Datentyp ist die Ausgabeformatierungseingabedatei.
PronunciationData	Datentypen sind Aussprachedaten.
Transcription	Der Typ der Daten ist transkription.
TranscriptionReport	Der Datentyp ist transkriptionsbericht.

FileLinks

Objekt

FileLinks

Name	Typ	Beschreibung
contentUrl	string (uri)	Die URL zum Abrufen des Inhalts dieser Datei.

FileProperties

Objekt

FileProperties

Name	Typ	Beschreibung
duration	string	Die Dauer für den Fall, dass es sich bei dieser Datei um eine Audiodatei handelt. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).
size	integer (int64)	Die Größe der Daten in Byte.

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

PaginatedFiles

Objekt

PaginatedFiles

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

File[]

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.

Freigeben über

Evaluations - List Files

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Get all files

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

Zusätzliche Ressourcen