Transcriptions - List Files

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
v3.2-preview.2

Získá soubory přepisu identifikované daným ID.

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files
S volitelnými parametry: 
GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&skip={skip}&top={top}&filter={filter}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
id
 path True

string

uuid

Identifikátor přepisu.
filter
 query

string

Filtrovací výraz pro výběr podmnožině dostupných souborů.

        - 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

Doba trvání v sekundách, po kterou by adresa URL SAS měla být platná. Výchozí doba trvání je 12 hodin. Při použití BYOS (https://video2.skills-academy.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): Hodnota 0 znamená, že se vygeneruje identifikátor URI prostého objektu blob bez tokenu SAS.
skip
 query

integer

int32

Počet datových sad, které budou vynechány.
top
 query

integer

int32

Počet datových sad, které budou zahrnuty po přeskočení

Odpovědi

Name Typ Description
200 OK

PaginatedFiles

OK

Hlavičky

Retry-After: integer
Other Status Codes

Error

Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vrácený službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu do adresy URL služby STS: ?scope=speechservicesmanagement.

Typ: apiKey
V: header

Příklady

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

Get all files

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "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

Ukázkový požadavek

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'

Ukázková odpověď

Stavový kód:
200 
{
  "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"
      }
    }
  ]
}

Definice

Name Description
DetailedErrorCode

Podrobný kód chyby
Error

Chyba
ErrorCode

ErrorCode
File

File
FileKind

SouborKind
FileLinks

Odkazy na soubory
FileProperties

Vlastnosti souboru
InnerError

Vnitřní chyba
PaginatedFiles

Stránkované soubory

DetailedErrorCode

Podrobný kód chyby

Name Typ Description
DataImportFailed

string

Import dat se nezdařil.
DeleteNotAllowed

string

Odstranění není povoleno.
DeployNotAllowed

string

Nasazení není povoleno.
DeployingFailedModel

string

Nasazení neúspěšného modelu
EmptyRequest

string

Prázdný požadavek.
EndpointCannotBeDefault

string

Koncový bod nemůže být výchozí.
EndpointNotUpdatable

string

Koncový bod není možné aktualizovat.
EndpointWithoutLogging

string

Koncový bod bez protokolování.
ExceededNumberOfRecordingsUris

string

Překročili jsme počet nahrávek uris.
FailedDataset

string

Datová sada se nezdařila.
Forbidden

string

Zakázáno.
InUseViolation

string

Porušením používání.
InaccessibleCustomerStorage

string

Nepřístupné úložiště zákazníka.
InvalidAdaptationMapping

string

Neplatné mapování adaptace
InvalidBaseModel

string

Neplatný základní model.
InvalidCallbackUri

string

Neplatný identifikátor URI zpětného volání
InvalidCollection

string

Neplatná kolekce.
InvalidDataset

string

Neplatná datová sada
InvalidDocument

string

Neplatný dokument.
InvalidDocumentBatch

string

Neplatná dávka dokumentu.
InvalidLocale

string

Neplatné národní prostředí.
InvalidLogDate

string

Neplatné datum protokolu
InvalidLogEndTime

string

Neplatný koncový čas protokolu.
InvalidLogId

string

Neplatné ID protokolu.
InvalidLogStartTime

string

Neplatný čas spuštění protokolu.
InvalidModel

string

Neplatný model.
InvalidModelUri

string

Neplatný identifikátor URI modelu
InvalidParameter

string

Neplatný parametr.
InvalidParameterValue

string

Neplatná hodnota parametru
InvalidPayload

string

Neplatná datová část.
InvalidPermissions

string

Neplatná oprávnění.
InvalidPrerequisite

string

Neplatný předpoklad.
InvalidProductId

string

Neplatné ID produktu.
InvalidProject

string

Neplatný projekt.
InvalidProjectKind

string

Neplatný druh projektu.
InvalidRecordingsUri

string

Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat

string

Neplatný formát textu požadavku.
InvalidSasValidityDuration

string

Neplatná doba platnosti sas.
InvalidSkipTokenForLogs

string

Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId

string

Neplatné ID zdrojového prostředku Azure.
InvalidSubscription

string

Neplatné předplatné.
InvalidTest

string

Neplatný test.
InvalidTimeToLive

string

Neplatný čas do života.
InvalidTopForLogs

string

Neplatná horní část pro protokoly.
InvalidTranscription

string

Neplatný přepis.
InvalidWebHookEventKind

string

Neplatný druh události web hooku
MissingInputRecords

string

Chybí vstupní záznamy.
ModelCopyOperationExists

string

Existuje operace kopírování modelu.
ModelDeploymentNotCompleteState

string

Nasazení modelu není dokončeno.
ModelDeprecated

string

Model je zastaralý.
ModelExists

string

Model existuje.
ModelMismatch

string

Neshoda modelů.
ModelNotDeployable

string

Model nejde nasadit.
ModelVersionIncorrect

string

Nesprávná verze modelu.
NoUtf8WithBom

string

Ne utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Pouze jednu z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch

string

Neshoda mezi pohlavími projektu.
QuotaViolation

string

Porušení kvóty.
SingleDefaultEndpoint

string

Jeden výchozí koncový bod.
SkuLimitsExist

string

Existují omezení skladových položek.
SubscriptionNotFound

string

Předplatné se nenašlo.
UnexpectedError

string

Neočekávaná chyba.
UnsupportedClassBasedAdaptation

string

Nepodporovaná adaptace na základě tříd.
UnsupportedDelta

string

Nepodporovaný rozdíl.
UnsupportedDynamicConfiguration

string

Nepodporovaná dynamická konfigurace.
UnsupportedFilter

string

Nepodporovaný filtr.
UnsupportedLanguageCode

string

Nepodporovaný kód jazyka.
UnsupportedOrderBy

string

Nepodporované pořadí podle.
UnsupportedPagination

string

Nepodporované stránkování.
UnsupportedTimeRange

string

Nepodporovaný časový rozsah.

Error

Chyba

Name Typ Description
code

ErrorCode

ErrorCode
Kódy chyb vysoké úrovně.
details

Error[]

Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError

InnerError

Vnitřní chyba
Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message

string

Chybová zpráva vysoké úrovně.
target

string

Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

ErrorCode

ErrorCode

Name Typ Description
Conflict

string

Představuje kód chyby konfliktu.
Forbidden

string

Představuje zakázaný kód chyby.
InternalCommunicationFailed

string

Představuje kód chyby selhání interní komunikace.
InternalServerError

string

Představuje kód vnitřní chyby serveru.
InvalidArgument

string

Představuje neplatný kód chyby argumentu.
InvalidRequest

string

Představuje neplatný kód chyby požadavku.
NotAllowed

string

Představuje nepovolený kód chyby.
NotFound

string

Představuje kód chyby nenalezena.
PipelineError

string

Představuje kód chyby kanálu.
ServiceUnavailable

string

Představuje kód chyby nedostupné služby.
TooManyRequests

string

Představuje kód chyby příliš mnoho požadavků.
Unauthorized

string

Představuje neoprávněný kód chyby.
UnprocessableEntity

string

Představuje nezpracovaný kód chyby entity.
UnsupportedMediaType

string

Představuje kód chyby nepodporovaného typu média.

File

File

Name Typ Description
createdDateTime

string

Čas vytvoření tohoto souboru. Časové razítko je kódováno jako formát data a času ISO 8601 (viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

SouborKind
Typ dat.
links

FileLinks

Odkazy na soubory
name

string

Název tohoto souboru.
properties

FileProperties

Vlastnosti souboru
self

string

Umístění této entity.

FileKind

SouborKind

Name Typ Description
AcousticDataArchive

string

Typ dat je akustický archiv dat.
AcousticDataTranscriptionV2

string

Typ dat je akustický přepis dat v2.
Audio

string

Typ dat je zvuk.
DatasetReport

string

Typ dat je sestava datové sady.
EvaluationDetails

string

Typ dat jsou podrobnosti vyhodnocení.
LanguageData

string

Typ dat jsou jazyková data.
ModelReport

string

Typ dat je modelová sestava.
OutputFormattingData

string

Typ dat je výstupní formátovací vstupní soubor.
PronunciationData

string

Typ dat jsou data výslovnosti.
Transcription

string

Typ dat je přepis.
TranscriptionReport

string

Typ dat je sestava přepisu.

Odkazy na soubory

Name Typ Description
contentUrl

string

Adresa URL pro načtení obsahu tohoto souboru

FileProperties

Vlastnosti souboru

Name Typ Description
duration

string

Doba trvání v případě, že se jedná o zvukový soubor. Doba trvání je zakódovaná jako doba trvání ISO 8601 ("PnYnMnDTnHnMnS", viz https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer

Velikost dat v bajtech.

InnerError

Vnitřní chyba

Name Typ Description
code

DetailedErrorCode

Podrobný kód chyby
Podrobný výčet kódu chyby
details

object

Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError

InnerError

Vnitřní chyba
Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message

string

Chybová zpráva vysoké úrovně.
target

string

Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

PaginatedFiles

Stránkované soubory

Name Typ Description
@nextLink

string

Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.
values

File[]

Seznam entit omezených parametry předaného dotazu "skip" a "top" nebo jejich výchozími hodnotami.

Při iteraci seznamem pomocí stránkování a paralelním odstraňování entit se některé entity ve výsledcích přeskočí. Doporučujeme vytvořit seznam na klientovi a po načtení úplného seznamu ho odstranit.