Udostępnij za pośrednictwem

Models - Get File

Usługa:
Azure AI Services
Wersja interfejsu API:
v3.2-preview.2

Pobiera jeden konkretny plik (identyfikowany z identyfikatorem fileId) z modelu (identyfikowany z identyfikatorem).

GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}/files/{fileId}
Z parametrami opcjonalnymi: 
GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}/files/{fileId}?sasValidityInSeconds={sasValidityInSeconds}

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).
fileId
 path True

string (uuid)

Identyfikator pliku.
id
 path True

string (uuid)

Identyfikator modelu.
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.

Odpowiedzi

Nazwa Typ Opis
200 OK

File

OK
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 a file

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?sasValidityInSeconds=120

Przykładowa odpowiedź

Kod stanu:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.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"
  }
}

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

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość Opis
InvalidParameterValue

Nieprawidłowa wartość parametru.
InvalidRequestBodyFormat

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

Puste żądanie.
MissingInputRecords

Brak rekordów wejściowych.
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 użycia.
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łowe wymaganie wstępne.
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 lub kontenera lub zestawu danych.
ExceededNumberOfRecordingsUris

Przekroczono liczbę nagrań uris.
ModelMismatch

Niezgodność modelu.
ProjectGenderMismatch

Niezgodność płci projektu.
ModelDeprecated

Model jest przestarzały.
ModelExists

Model istnieje.
ModelNotDeployable

Nie można wdrożyć modelu.
EndpointNotUpdatable

Punkt końcowy nie można aktualizować.
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 można odnaleźć subskrypcji.
QuotaViolation

Naruszenie limitu przydziału.
UnsupportedDelta

Nieobsługiwana delta.
UnsupportedFilter

Nieobsługiwany filtr.
UnsupportedPagination

Nieobsługiwane stronicowanie.
UnsupportedDynamicConfiguration

Nieobsługiwana konfiguracja dynamiczna.
UnsupportedOrderBy

Nieobsługiwana kolejność według.
NoUtf8WithBom

Brak utf8 z bom.
ModelDeploymentNotCompleteState

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

Istnieją limity jednostek SKU.
DeployingFailedModel

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

Nieobsługiwany zakres czasu.
InvalidLogDate

Nieprawidłowa data dziennika.
InvalidLogId

Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime

Nieprawidłowy czas rozpoczęcia dziennika.
InvalidLogEndTime

Nieprawidłowy czas zakończenia dziennika.
InvalidTopForLogs

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

Nieprawidłowy token pomijania dzienników.
DeleteNotAllowed

Usuń 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 wygaśnięcia.
InvalidSourceAzureResourceId

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

Istnieje operacja kopiowania modelu.

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
InvalidRequest

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

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

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

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

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

Reprezentowanie kodu błędu potoku.
Conflict

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

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

Reprezentowanie niedozwolonego kodu błędu.
NotAllowed

Reprezentowanie niedozwolonego kodu błędu.
Unauthorized

Reprezentowanie nieautoryzowanego kodu błędu.
UnsupportedMediaType

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

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

Reprezentowanie nieprzetworzonego kodu błędu jednostki.

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
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 wymowy.
AcousticDataArchive

Typ danych to archiwum danych akustycznych.
AcousticDataTranscriptionV2

Typ danych to transkrypcja danych akustycznych w wersji 2.
Transcription

Typ danych to transkrypcja.
TranscriptionReport

Typ danych to raport transkrypcji.
EvaluationDetails

Typ danych to szczegóły oceny.
ModelReport

Typ danych to raport modelu.
OutputFormattingData

Typ danych to formatowanie pliku wejściowego.
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.