Transcriptions - List Files

  • Referens
Tjänst:
Azure AI Services
API-version:
3.2

Hämtar filerna för transkriptionen som identifieras av det angivna ID:t.

GET {endpoint}/speechtotext/v3.2/transcriptions/{id}/files
Med valfria parametrar: 
GET {endpoint}/speechtotext/v3.2/transcriptions/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&skip={skip}&top={top}&filter={filter}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
id
 path True

string

uuid

Identifieraren för transkriptionen.
filter
 query

string

Ett filtreringsuttryck för att välja en delmängd av de tillgängliga filerna.

        - 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

Varaktigheten i sekunder som en SAS-URL ska vara giltig. Standardvaraktigheten är 12 timmar. När du använder 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): Värdet 0 innebär att en oformaterad blob-URI utan SAS-token genereras.
skip
 query

integer

int32

Antal datauppsättningar som ska hoppas över.
top
 query

integer

int32

Antal datauppsättningar som ska inkluderas när du hoppar över.

Svar

Name Typ Description
200 OK

PaginatedFiles

OK

Sidhuvuden

Retry-After: integer
Other Status Codes

Error

Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

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

Get all files

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2"
}

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

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
      }
    }
  ]
}

Definitioner

Name Description
DetailedErrorCode

DetailedErrorCode
Error

Fel
ErrorCode

Felkod
File

Fil
FileKind

FileKind
FileLinks

FileLinks
FileProperties

FileProperties
InnerError

InnerError
PaginatedFiles

Sidnumrerade filer

DetailedErrorCode

DetailedErrorCode

Name Typ Description
DataImportFailed

string

Dataimporten misslyckades.
DeleteNotAllowed

string

Ta bort tillåts inte.
DeployNotAllowed

string

Distribution tillåts inte.
DeployingFailedModel

string

Distributionen av en misslyckad modell.
EmptyRequest

string

Tom begäran.
EndpointCannotBeDefault

string

Slutpunkten kan inte vara standard.
EndpointNotUpdatable

string

Slutpunkten kan inte uppdateras.
EndpointWithoutLogging

string

Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris

string

Överskred antalet inspelningar uris.
FailedDataset

string

Datauppsättningen misslyckades.
Forbidden

string

Förbjudet.
InUseViolation

string

Vid användningsöverträdelse.
InaccessibleCustomerStorage

string

Otillgänglig kundlagring.
InvalidAdaptationMapping

string

Ogiltig anpassningsmappning.
InvalidBaseModel

string

Ogiltig basmodell.
InvalidCallbackUri

string

Ogiltig återanrops-uri.
InvalidChannels

string

Ogiltiga kanaler.
InvalidCollection

string

Ogiltig samling.
InvalidDataset

string

Ogiltig datauppsättning.
InvalidDocument

string

Ogiltigt dokument.
InvalidDocumentBatch

string

Ogiltig dokumentbatch.
InvalidLocale

string

Ogiltigt språk.
InvalidLogDate

string

Ogiltigt loggdatum.
InvalidLogEndTime

string

Ogiltig loggsluttid.
InvalidLogId

string

Ogiltigt logg-ID.
InvalidLogStartTime

string

Ogiltig starttid för loggen.
InvalidModel

string

Ogiltig modell.
InvalidModelUri

string

Ogiltig modell-URI.
InvalidParameter

string

Ogiltig parameter.
InvalidParameterValue

string

Ogiltigt parametervärde.
InvalidPayload

string

Ogiltig nyttolast.
InvalidPermissions

string

Ogiltiga behörigheter.
InvalidPrerequisite

string

Ogiltig förutsättning.
InvalidProductId

string

Ogiltigt produkt-ID.
InvalidProject

string

Ogiltigt projekt.
InvalidProjectKind

string

Ogiltig projekttyp.
InvalidRecordingsUri

string

Ogiltig inspelnings-URI.
InvalidRequestBodyFormat

string

Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration

string

Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs

string

Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId

string

Ogiltigt käll-Azure-resurs-ID.
InvalidSubscription

string

Ogiltig prenumeration.
InvalidTest

string

Ogiltigt test.
InvalidTimeToLive

string

Ogiltig tid att leva.
InvalidTopForLogs

string

Ogiltig överkant för loggar.
InvalidTranscription

string

Ogiltig transkription.
InvalidWebHookEventKind

string

Ogiltig webbhookhändelsetyp.
MissingInputRecords

string

Indataposter saknas.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization har upphört att gälla.
ModelDeploymentNotCompleteState

string

Modelldistributionen är inte fullständigt.
ModelDeprecated

string

Modellen är inaktuell.
ModelExists

string

Modellen finns.
ModelMismatch

string

Modellmatchningsfel.
ModelNotDeployable

string

Modellen kan inte distribueras.
ModelVersionIncorrect

string

Modellversionen är felaktig.
NoUtf8WithBom

string

Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Endast en av URL:erna eller containern eller datauppsättningen.
ProjectGenderMismatch

string

Matchningsfel för projektkön.
QuotaViolation

string

Kvotöverträdelse.
SingleDefaultEndpoint

string

Enskild standardslutpunkt.
SkuLimitsExist

string

Det finns SKU-gränser.
SubscriptionNotFound

string

Det går inte att hitta prenumerationen.
UnexpectedError

string

Oväntat fel.
UnsupportedClassBasedAdaptation

string

Klassbaserad anpassning stöds inte.
UnsupportedDelta

string

Delta stöds inte.
UnsupportedDynamicConfiguration

string

Dynamisk konfiguration stöds inte.
UnsupportedFilter

string

Filter som inte stöds.
UnsupportedLanguageCode

string

Språkkod som inte stöds.
UnsupportedOrderBy

string

Order som inte stöds av.
UnsupportedPagination

string

Sidnumrering stöds inte.
UnsupportedTimeRange

string

Tidsintervallet stöds inte.

Error

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder på hög nivå.
details

Error[]

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name Typ Description
Conflict

string

Representerar konfliktfelkoden.
Forbidden

string

Representerar den otillåtna felkoden.
InternalCommunicationFailed

string

Det gick inte att representera felkoden för intern kommunikation.
InternalServerError

string

Representerar felkoden för den interna servern.
InvalidArgument

string

Representerar den ogiltiga argumentfelkoden.
InvalidRequest

string

Representerar felkoden för ogiltig begäran.
NotAllowed

string

Representerar den felkod som inte tillåts.
NotFound

string

Representerar felkoden som inte hittades.
PipelineError

string

Representerar felkoden för pipelinefel.
ServiceUnavailable

string

Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests

string

Representerar felkoden för många begäranden.
Unauthorized

string

Representerar den otillåtna felkoden.
UnprocessableEntity

string

Representerar felkoden för entiteten som inte kan bearbetas.
UnsupportedMediaType

string

Representerar felkoden för medietypen som inte stöds.

File

Fil

Name Typ Description
createdDateTime

string

Skapandetiden för den här filen. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat (se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

FileKind
Typ av data.
links

FileLinks

FileLinks
name

string

Namnet på den här filen.
properties

FileProperties

FileProperties
self

string

Platsen för den här entiteten.

FileKind

FileKind

Name Typ Description
AcousticDataArchive

string

Typ av data är akustiskt dataarkiv.
AcousticDataTranscriptionV2

string

Typ av data är akustisk dataavskrift v2.
Audio

string

Typ av data är ljud.
DatasetReport

string

Typ av data är datauppsättningsrapport.
EvaluationDetails

string

Typ av data är utvärderingsinformation.
LanguageData

string

Typ av data är språkdata.
ModelReport

string

Typ av data är modellrapport.
OutputFormattingData

string

Typ av data är indatafilen för utdataformatering.
PronunciationData

string

Typ av data är uttalsdata.
Transcription

string

Typ av data är transkription.
TranscriptionReport

string

Typ av data är transkriptionsrapport.

FileLinks

Name Typ Description
contentUrl

string

Url:en för att hämta innehållet i den här filen.

FileProperties

FileProperties

Name Typ Description
duration

string

Varaktigheten om den här filen är en ljudfil. Varaktigheten kodas som ISO 8601-varaktighet ("PnYnMnDTnHnMnS", se https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer

Storleken på data i byte.

InnerError

InnerError

Name Typ Description
code

DetailedErrorCode

DetailedErrorCode
Detaljerad felkodsuppräkning.
details

object

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

PaginatedFiles

Sidnumrerade filer

Name Typ Description
@nextLink

string

En länk till nästa uppsättning sidnumrerade resultat om det finns fler entiteter tillgängliga. annars null.
values

File[]

En lista över entiteter som begränsas av antingen de skickade frågeparametrarna "skip" och "top" eller deras standardvärden.

När du itererar genom en lista med sidnumrering och tar bort entiteter parallellt hoppas vissa entiteter över i resultatet. Vi rekommenderar att du skapar en lista på klienten och tar bort efter hämtningen av den fullständiga listan.