Freigeben über


Transcriptions - List Files

Ruft die Dateien der Transkription ab, die durch die angegebene ID identifiziert werden.

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files
GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{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 Transkription.

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.json' and kind eq 'Transcription'
sasValidityInSeconds
query

integer

int32

Die Dauer in Sekunden, für 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): Der Wert 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

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

Antworten

Name Typ Beschreibung
200 OK

PaginatedFiles

OK

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 files
Get all transcription files the name of which starts with the specified string

Get all files

Beispielanforderung

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Beispiel für eine Antwort

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef",
      "name": "mywavefile2.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2"
}

Get all transcription files the name of which starts with the specified string

Beispielanforderung

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=10&filter=name%20eq%20'mywavefile1.wav.json'

Beispiel für eine Antwort

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.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"
      }
    }
  ]
}

Definitionen

Name Beschreibung
DetailedErrorCode

DetailedErrorCode

Error

Fehler

ErrorCode

ErrorCode

File

Datei

FileKind

FileKind

FileLinks

FileLinks

FileProperties

Fileproperties

InnerError

InnerError

PaginatedFiles

PaginatedFiles

DetailedErrorCode

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.

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

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.

File

Datei

Name Typ Beschreibung
createdDateTime

string

Die Erstellungszeit dieser Datei. Der Zeitstempel ist 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

Der Speicherort dieser Entität.

FileKind

FileKind

Name Typ Beschreibung
AcousticDataArchive

string

Der Typ der Daten ist Akustikdatenarchiv.

AcousticDataTranscriptionV2

string

Der Datentyp ist Akustikdatentranskription v2.

Audio

string

Der Typ der Daten ist Audio.

DatasetReport

string

Der Typ der Daten ist der Datasetbericht.

EvaluationDetails

string

Der Typ der Daten sind Auswertungsdetails.

LanguageData

string

Der Typ der Daten sind Sprachdaten.

ModelReport

string

Der Typ der Daten ist der Modellbericht.

OutputFormattingData

string

Der Typ der Daten ist die Eingabedatei für die Ausgabeformatierung.

PronunciationData

string

Der Typ der Daten sind Aussprachedaten.

Transcription

string

Der Typ der Daten ist die Transkription.

TranscriptionReport

string

Der Typ der Daten ist der Transkriptionsbericht.

FileLinks

Name Typ Beschreibung
contentUrl

string

Die URL zum Abrufen des Inhalts dieser Datei.

FileProperties

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

Die Größe der Daten in Bytes.

InnerError

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.

PaginatedFiles

PaginatedFiles

Name Typ Beschreibung
@nextLink

string

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

values

File[]

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.