Udostępnij za pośrednictwem

Models - List Files

  • Odwołanie
Usługa:
Azure AI Services
Wersja interfejsu API:
3.2

Pobiera pliki modelu zidentyfikowane przez dany identyfikator.

GET {endpoint}/speechtotext/v3.2/models/{id}/files
Z parametrami opcjonalnymi: 
GET {endpoint}/speechtotext/v3.2/models/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&skip={skip}&top={top}&filter={filter}

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 modelu.
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'
sasValidityInSeconds
 query

integer (int32)

Czas trwania w sekundach, przez który adres URL sygnatury dostępu współdzielonego powinien być prawidłowy. Domyślny czas trwania to 12 godzin. W przypadku korzystania z funkcji 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): wartość 0 oznacza, że zostanie wygenerowany zwykły identyfikator URI obiektu blob bez tokenu SAS.
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.

Odpowiedzi

Nazwa Typ Opis
200 OK

PaginatedFiles

OK

Nagłówki

Retry-After: integer
Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z zestawu JWT zwróconego przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Get all files

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Przykładowa odpowiedź

Kod stanu:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "ModelReport",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "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"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definicje

Nazwa Opis
DetailedErrorCode

DetailedErrorCode
Error

Błąd
ErrorCode

Kod błędu
File

Plik
FileKind

FileKind
FileLinks

ŁączaPlików
FileProperties

Właściwości pliku
InnerError

InnerError
PaginatedFiles

Pliki podzielone na strony

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość Opis
DataImportFailed

Importowanie danych nie powiodło się.
DeleteNotAllowed

Usuń niedozwolone.
DeployNotAllowed

Wdrażanie jest niedozwolone.
DeployingFailedModel

Wdrażanie modelu nie powiodło się.
EmptyRequest

Puste żądanie.
EndpointCannotBeDefault

Punkt końcowy nie może być domyślny.
EndpointNotUpdatable

Punkt końcowy nie można aktualizować.
EndpointWithoutLogging

Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris

Przekroczono liczbę nagrań uris.
FailedDataset

Zestaw danych, który zakończył się niepowodzeniem.
Forbidden

Zakazany.
InUseViolation

Naruszenie użycia.
InaccessibleCustomerStorage

Niedostępny magazyn klienta.
InvalidAdaptationMapping

Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel

Nieprawidłowy model podstawowy.
InvalidCallbackUri

Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidChannels

Nieprawidłowe kanały.
InvalidCollection

Nieprawidłowa kolekcja.
InvalidDataset

Nieprawidłowy zestaw danych.
InvalidDocument

Nieprawidłowy dokument.
InvalidDocumentBatch

Nieprawidłowa partia dokumentów.
InvalidLocale

Nieprawidłowe ustawienia regionalne.
InvalidLogDate

Nieprawidłowa data dziennika.
InvalidLogEndTime

Nieprawidłowy czas zakończenia dziennika.
InvalidLogId

Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime

Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel

Nieprawidłowy model.
InvalidModelUri

Nieprawidłowy identyfikator URI modelu.
InvalidParameter

Nieprawidłowy parametr.
InvalidParameterValue

Nieprawidłowa wartość parametru.
InvalidPayload

Nieprawidłowy ładunek.
InvalidPermissions

Nieprawidłowe uprawnienia.
InvalidPrerequisite

Nieprawidłowe wymaganie wstępne.
InvalidProductId

Nieprawidłowy identyfikator produktu.
InvalidProject

Nieprawidłowy projekt.
InvalidProjectKind

Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri

Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat

Nieprawidłowy format treści żądania.
InvalidSasValidityDuration

Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs

Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId

Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
InvalidSubscription

Nieprawidłowa subskrypcja.
InvalidTest

Nieprawidłowy test.
InvalidTimeToLive

Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs

Nieprawidłowy górny element dla dzienników.
InvalidTranscription

Nieprawidłowa transkrypcja.
InvalidWebHookEventKind

Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords

Brak rekordów wejściowych.
ModelCopyAuthorizationExpired

Wygasła metoda ModelCopyAuthorization.
ModelDeploymentNotCompleteState

Wdrożenie modelu nie zostało ukończone.
ModelDeprecated

Model jest przestarzały.
ModelExists

Model istnieje.
ModelMismatch

Niezgodność modelu.
ModelNotDeployable

Nie można wdrożyć modelu.
ModelVersionIncorrect

Nieprawidłowa wersja modelu.
NoUtf8WithBom

Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset

Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch

Niezgodność płci projektu.
QuotaViolation

Naruszenie limitu przydziału.
SingleDefaultEndpoint

Pojedynczy domyślny punkt końcowy.
SkuLimitsExist

Istnieją limity jednostek SKU.
SubscriptionNotFound

Nie można odnaleźć subskrypcji.
UnexpectedError

Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation

Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta

Nieobsługiwana delta.
UnsupportedDynamicConfiguration

Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter

Nieobsługiwany filtr.
UnsupportedLanguageCode

Nieobsługiwany kod języka.
UnsupportedOrderBy

Nieobsługiwana kolejność według.
UnsupportedPagination

Nieobsługiwane stronicowanie.
UnsupportedTimeRange

Nieobsługiwany zakres czasu.

Error

Objekt

Błąd

Nazwa Typ Opis
code

ErrorCode

Kod błędu
Kody błędów wysokiego poziomu.
details

Error[]

Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError

InnerError

InnerError
Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message

string

Komunikat o błędzie wysokiego poziomu.
target

string

Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Wyliczanie

Kod błędu

Wartość Opis
Conflict

Reprezentowanie kodu błędu powodującego konflikt.
Forbidden

Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed

Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
InternalServerError

Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument

Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest

Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed

Reprezentowanie niedozwolonego kodu błędu.
NotFound

Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError

Reprezentowanie kodu błędu potoku.
ServiceUnavailable

Reprezentowanie niedostępnego kodu błędu usługi.
TooManyRequests

Reprezentując kod błędu zbyt wielu żądań.
Unauthorized

Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity

Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType

Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

File

Objekt

Plik

Nazwa Typ Opis
createdDateTime

string (date-time)

Czas tworzenia tego pliku. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 (zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

FileKind
Typ danych.
links

FileLinks

ŁączaPlików
name

string

Nazwa tego pliku.
properties

FileProperties

Właściwości pliku
self

string (uri)

Lokalizacja tej jednostki.

FileKind

Wyliczanie

FileKind

Wartość Opis
AcousticDataArchive

Typ danych to archiwum danych akustycznych.
AcousticDataTranscriptionV2

Typ danych to transkrypcja danych akustycznych w wersji 2.
Audio

Typ danych to dźwięk.
DatasetReport

Typ danych to raport zestawu danych.
EvaluationDetails

Typ danych to szczegóły oceny.
LanguageData

Typ danych to dane językowe.
ModelReport

Typ danych to raport modelu.
OutputFormattingData

Typ danych to formatowanie pliku wejściowego.
PronunciationData

Typ danych to dane wymowy.
Transcription

Typ danych to transkrypcja.
TranscriptionReport

Typ danych to raport transkrypcji.
Objekt

ŁączaPlików

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

string

Czas trwania w przypadku, gdy ten plik jest plikiem audio. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer (int64)

Rozmiar danych w bajtach.

InnerError

Objekt

InnerError

Nazwa Typ Opis
code

DetailedErrorCode

DetailedErrorCode
Szczegółowy wyliczenie kodu błędu.
details

object

Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError

InnerError

InnerError
Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message

string

Komunikat o błędzie wysokiego poziomu.
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 za pośrednictwem listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.