Datasets - List Files

Usługa:: Azure AI Services

Wersja interfejsu API:: 2025-10-15

Pobiera pliki zestawu danych identyfikowanego przez podany identyfikator.

GET {endpoint}/speechtotext/datasets/{id}/files?api-version=2025-10-15

Z parametrami opcjonalnymi:

GET {endpoint}/speechtotext/datasets/{id}/files?sasLifetimeMinutes={sasLifetimeMinutes}&skip={skip}&top={top}&filter={filter}&api-version=2025-10-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identyfikator zbioru danych.
api-version	query	True	string	Żądana wersja interfejsu API.
filter	query		string	Wyrażenie filtrowania służące do wybierania podzestawu dostępnych plików. `- 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'`
sasLifetimeMinutes	query		integer (int32)	Ten parametr definiuje czas trwania w minutach, przez który adres URL sygnatury dostępu współdzielonego powinien być prawidłowy. `The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token.`
skip	query		integer (int32)	Liczba zestawów danych, które zostaną pominięte.
top	query		integer (int32)	Liczba zestawów danych, które zostaną uwzględnione po pomijaniu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Podaj klucz konta usług Cognitive Services w tym miejscu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PaginatedFiles	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

PaginatedFiles

Nagłówki

Retry-After: integer

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Podaj klucz konta usług Cognitive Services w tym miejscu.

Typ: apiKey
W: header

Przykłady

Get all dataset report files

Get all files

Get all dataset report files

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=10&filter=kind%20eq%20'DatasetReport'&api-version=2025-10-15

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ]
}

Get all files

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2025-10-15

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86?api-version=3.2",
      "name": "language_data.txt",
      "kind": "LanguageData",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2025-10-15"
}

Definicje

Nazwa	Opis
DetailedErrorCode	Szczegółowy kod błędu
Error	Error
ErrorCode	ErrorCode
File	File
FileKind	FileKind
FileLinks	PlikiLinki
FileProperties	Właściwości pliku
InnerError	InnerError
PaginatedFiles	Pliki podzielone na strony

DetailedErrorCode

Wyliczanie

Szczegółowy kod błędu

Wartość	Opis
InvalidParameterValue	Nieprawidłowa wartość parametru.
InvalidRequestBodyFormat	Nieprawidłowy format treści żądania.
EmptyRequest	Puste żądanie.
MissingInputRecords	Brakujące rekordy wejściowe.
InvalidDocument	Nieprawidłowy dokument.
ModelVersionIncorrect	Nieprawidłowa wersja modelu.
InvalidDocumentBatch	Nieprawidłowa partia dokumentów.
UnsupportedLanguageCode	Nieobsługiwany kod języka.
DataImportFailed	Importowanie danych nie powiodło się.
InUseViolation	Naruszenie zasad użytkowania.
InvalidLocale	Nieprawidłowe ustawienia regionalne.
InvalidBaseModel	Nieprawidłowy model podstawowy.
InvalidAdaptationMapping	Nieprawidłowe mapowanie adaptacji.
InvalidDataset	Nieprawidłowy zestaw danych.
InvalidTest	Nieprawidłowy test.
FailedDataset	Zestaw danych, który zakończył się niepowodzeniem.
InvalidModel	Nieprawidłowy model.
InvalidTranscription	Nieprawidłowa transkrypcja.
InvalidPayload	Nieprawidłowy ładunek.
InvalidParameter	Nieprawidłowy parametr.
EndpointWithoutLogging	Punkt końcowy bez rejestrowania.
InvalidPermissions	Nieprawidłowe uprawnienia.
InvalidPrerequisite	Nieprawidłowy warunek wstępny.
InvalidProductId	Nieprawidłowy identyfikator produktu.
InvalidSubscription	Nieprawidłowa subskrypcja.
InvalidProject	Nieprawidłowy projekt.
InvalidProjectKind	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	Nieprawidłowy identyfikator URI nagrań.
OnlyOneOfUrlsOrContainerOrDataset	Tylko jeden z adresów URL, kontener lub zestaw danych.
ExceededNumberOfRecordingsUris	Przekroczono liczbę identyfikatorów URI nagrań.
InvalidChannels	Nieprawidłowe kanały.
ModelMismatch	Niezgodność modelu.
ProjectGenderMismatch	Projekt niedopasowania płci.
ModelDeprecated	Model przestarzały.
ModelExists	Model istnieje.
ModelNotDeployable	Model nie można wdrożyć.
EndpointNotUpdatable	Nie można zaktualizować punktu końcowego.
SingleDefaultEndpoint	Pojedynczy domyślny punkt końcowy.
EndpointCannotBeDefault	Punkt końcowy nie może być domyślny.
InvalidModelUri	Nieprawidłowy identyfikator URI modelu.
SubscriptionNotFound	Nie znaleziono subskrypcji.
QuotaViolation	Naruszenie limitu przydziału.
UnsupportedDelta	Nieobsługiwana delta.
UnsupportedFilter	Nieobsługiwany filtr.
UnsupportedPagination	Nieobsługiwana stronicowanie.
UnsupportedDynamicConfiguration	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedOrderBy	Nieobsługiwane zamówienie przez.
NoUtf8WithBom	Brak utf8 z bom.
ModelDeploymentNotCompleteState	Wdrożenie modelu nie jest ukończonym stanem.
SkuLimitsExist	Istnieją limity jednostek SKU.
DeployingFailedModel	Wdrażanie modelu, który zakończył się niepowodzeniem.
UnsupportedTimeRange	Nieobsługiwany zakres czasu.
InvalidLogDate	Nieprawidłowa data logowania.
InvalidLogId	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	Nieprawidłowa godzina rozpoczęcia dziennika.
InvalidLogEndTime	Nieprawidłowy czas zakończenia dziennika.
InvalidTopForLogs	Nieprawidłowa góra dla dzienników.
InvalidSkipTokenForLogs	Nieprawidłowy token pomijania dzienników.
DeleteNotAllowed	Usuwanie jest niedozwolone.
Forbidden	Zakazany.
DeployNotAllowed	Wdrażanie jest niedozwolone.
UnexpectedError	Nieoczekiwany błąd.
InvalidCollection	Nieprawidłowa kolekcja.
InvalidCallbackUri	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidSasValidityDuration	Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InaccessibleCustomerStorage	Niedostępny magazyn klienta.
UnsupportedClassBasedAdaptation	Nieobsługiwana adaptacja oparta na klasach.
InvalidWebHookEventKind	Nieprawidłowy rodzaj zdarzenia elementu webhook.
InvalidTimeToLive	Nieprawidłowy czas zamieszkania.
InvalidSourceAzureResourceId	Nieprawidłowy identyfikator źródłowego zasobu platformy Azure.
ModelCopyAuthorizationExpired	Wygasła autoryzacja ModelCopyAuthorization.
EndpointLoggingNotSupported	Rejestrowanie punktów końcowych nie jest obsługiwane.
NoLanguageIdentified	Identyfikacja języka nie rozpoznała żadnego języka.
MultipleLanguagesIdentified	Identyfikacja języka rozpoznała wiele języków. Nie udało się ustalić języka dominującego.
InvalidAudioFormat	Format dźwięku wejściowego nie jest obsługiwany.
BadChannelConfiguration	Istnieje niezgodność między kanałami audio w danych, konfiguracji lub wymaganiach aplikacji.
InvalidChannelSpecification	Wybór kanałów w żądaniu transkrypcji nie jest obsługiwany (np. nie wybrano ani 0, ani 1).
AudioLengthLimitExceeded	Plik audio jest dłuższy niż maksymalny dozwolony czas trwania.
EmptyAudioFile	Plik audio jest pusty.

Error

Objekt

Error

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe informacje pomocnicze dotyczące błędu i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego, który jest zgodny z wytycznymi dotyczącymi interfejsu API usług Cognitive Services, który jest dostępny pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera wymagane właściwości: ErrorCode, message i opcjonalne właściwości target, details (para klucz-wartość), błąd wewnętrzny (może być zagnieżdżony).
message	string	Ogólny komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Wyliczanie

ErrorCode

Wartość	Opis
InvalidRequest	Reprezentuje nieprawidłowy kod błędu żądania.
InvalidArgument	Reprezentujący kod błędu nieprawidłowego argumentu.
InternalServerError	Reprezentujący kod błędu wewnętrznego serwera.
ServiceUnavailable	Reprezentujący kod błędu niedostępności usługi.
NotFound	Reprezentuje kod błędu nie znaleziono.
PipelineError	Reprezentujący kod błędu potoku.
Conflict	Reprezentujący kod błędu konfliktu.
InternalCommunicationFailed	Reprezentowanie kodu błędu komunikacji wewnętrznej nie powiodło się.
Forbidden	Reprezentuje zabroniony kod błędu.
NotAllowed	Reprezentuje niedozwolony kod błędu.
Unauthorized	Reprezentuje nieautoryzowany kod błędu.
UnsupportedMediaType	Reprezentuje kod błędu nieobsługiwanego typu nośnika.
TooManyRequests	Reprezentujący kod błędu zbyt wielu żądań.
UnprocessableEntity	Reprezentujący kod błędu jednostki, której nie można przetworzyć.

File

Objekt

File

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Czas utworzenia tego pliku. Znacznik czasu jest zakodowany w formacie daty i godziny ISO 8601 (patrz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind	FileKind	FileKind Typ danych.
links	FileLinks	PlikiLinki
name	string	Nazwa tego pliku.
properties	FileProperties	Właściwości pliku
self	string (uri)	Lokalizacja tej jednostki.

FileKind

Wyliczanie

FileKind

Wartość	Opis
DatasetReport	Typ danych to raport zestawu danych.
Audio	Typ danych to dźwięk.
LanguageData	Typ danych to dane językowe.
PronunciationData	Typ danych to dane dotyczące wymowy.
AcousticDataArchive	Typ danych to archiwum danych akustycznych.
AcousticDataTranscriptionV2	Typ danych to akustyczna transkrypcja danych v2.
Transcription	Typem danych jest transkrypcja.
TranscriptionReport	Typ danych to raport z transkrypcji.
EvaluationDetails	Typ danych to szczegóły oceny.
ModelReport	Typ danych to raport modelowy.
OutputFormattingData	Typ danych to plik wyjściowy formatujący plik wejściowy.

FileLinks

Objekt

PlikiLinki

Nazwa	Typ	Opis
contentUrl	string (uri)	Adres URL umożliwiający pobranie zawartości tego pliku.

FileProperties

Objekt

Właściwości pliku

Nazwa	Typ	Domyślna wartość	Opis
durationMilliseconds	integer (int32)	0	Całkowity czas trwania pliku w milisekundach w przypadku, gdy ten plik jest plikiem audio.
size	integer (int64)		Rozmiar danych w bajtach.

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	Szczegółowy kod błędu Szczegółowy kod błędu wyliczenie.
details	object	Dodatkowe informacje pomocnicze dotyczące błędu i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego, który jest zgodny z wytycznymi dotyczącymi interfejsu API usług Cognitive Services, który jest dostępny pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera wymagane właściwości: ErrorCode, message i opcjonalne właściwości target, details (para klucz-wartość), błąd wewnętrzny (może być zagnieżdżony).
message	string	Ogólny komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

PaginatedFiles

Objekt

Pliki podzielone na strony

Nazwa	Typ	Opis
@nextLink	string (uri)	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.
values	File[]	Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. Podczas iteracji po liście przy użyciu stronicowania i równoległego usuwania jednostek niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.

Nazwa

Typ

Opis

@nextLink

string (uri)

Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.

values

File[]

Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne.

Podczas iteracji po liście przy użyciu stronicowania i równoległego usuwania jednostek niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.