Transcriptions - List Files

Referens

Tjänst:: Azure AI Services

API-version:: v3.2-preview.2

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

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files

Med valfria parametrar:

GET {endpoint}/speechtotext/v3.2-preview.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://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): Ett värde på 0 innebär att en vanlig 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 ingå när du hoppar över.

Svar

Name	Typ	Description
200 OK	PaginatedFiles	OK Sidhuvuden Retry-After: integer
Other Status Codes	Error	Ett fel uppstod.

Name

Typ

Description

200 OK

PaginatedFiles

Sidhuvuden

Retry-After: integer

Other Status Codes

Error

Ett fel uppstod.

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

HTTP

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

HTTP

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'

Exempelsvar

Statuskod:: 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"
      }
    }
  ]
}

Definitioner

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Fel
ErrorCode	Felkod
File	Fil
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError
PaginatedFiles	Sidnumrerade filer

DetailedErrorCode

Uppräkning

DetailedErrorCode

Värde	Description
DataImportFailed	Dataimporten misslyckades.
DeleteNotAllowed	Ta bort tillåts inte.
DeployNotAllowed	Distribution tillåts inte.
DeployingFailedModel	Distribution av en misslyckad modell.
EmptyRequest	Tom begäran.
EndpointCannotBeDefault	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	Överskred antalet inspelningar uris.
FailedDataset	Datauppsättningen misslyckades.
Forbidden	Förbjuden.
InUseViolation	Vid användningsöverträdelse.
InaccessibleCustomerStorage	Otillgänglig kundlagring.
InvalidAdaptationMapping	Ogiltig anpassningsmappning.
InvalidBaseModel	Ogiltig basmodell.
InvalidCallbackUri	Ogiltig återanrops-URI.
InvalidCollection	Ogiltig samling.
InvalidDataset	Ogiltig datauppsättning.
InvalidDocument	Ogiltigt dokument.
InvalidDocumentBatch	Ogiltig dokumentbatch.
InvalidLocale	Ogiltigt språk.
InvalidLogDate	Ogiltigt loggdatum.
InvalidLogEndTime	Ogiltig loggsluttid.
InvalidLogId	Ogiltigt logg-ID.
InvalidLogStartTime	Ogiltig starttid för loggen.
InvalidModel	Ogiltig modell.
InvalidModelUri	Ogiltig modell-URI.
InvalidParameter	Ogiltig parameter.
InvalidParameterValue	Ogiltigt parametervärde.
InvalidPayload	Ogiltig nyttolast.
InvalidPermissions	Ogiltiga behörigheter.
InvalidPrerequisite	Ogiltigt krav.
InvalidProductId	Ogiltigt produkt-ID.
InvalidProject	Ogiltigt projekt.
InvalidProjectKind	Ogiltig projekttyp.
InvalidRecordingsUri	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration	Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs	Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId	Ogiltigt azure-källresurs-ID.
InvalidSubscription	Ogiltig prenumeration.
InvalidTest	Ogiltigt test.
InvalidTimeToLive	Ogiltig tid att leva.
InvalidTopForLogs	Ogiltig topp för loggar.
InvalidTranscription	Ogiltig transkription.
InvalidWebHookEventKind	Ogiltig typ av webbhookhändelse.
MissingInputRecords	Indataposter saknas.
ModelCopyOperationExists	Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState	Modelldistributionen har inte slutförts.
ModelDeprecated	Modellen är inaktuell.
ModelExists	Modellen finns.
ModelMismatch	Modellmatchningsfel.
ModelNotDeployable	Modellen kan inte distribueras.
ModelVersionIncorrect	Modellversionen är felaktig.
NoUtf8WithBom	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	Endast en av url:erna eller containern eller datamängden.
ProjectGenderMismatch	Matchningsfel för projektkön.
QuotaViolation	Kvotöverträdelse.
SingleDefaultEndpoint	Enskild standardslutpunkt.
SkuLimitsExist	Det finns SKU-gränser.
SubscriptionNotFound	Det går inte att hitta prenumerationen.
UnexpectedError	Oväntat fel.
UnsupportedClassBasedAdaptation	Klassbaserad anpassning som inte stöds.
UnsupportedDelta	Delta stöds inte.
UnsupportedDynamicConfiguration	Dynamisk konfiguration stöds inte.
UnsupportedFilter	Filter som inte stöds.
UnsupportedLanguageCode	Språkkod som inte stöds.
UnsupportedOrderBy	Order som inte stöds av.
UnsupportedPagination	Sidnumrering stöds inte.
UnsupportedTimeRange	Tidsintervall som inte stöds.

Error

Objekt

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 (nyckel värde par), 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

Uppräkning

Felkod

Värde	Description
Conflict	Representerar konfliktfelkoden.
Forbidden	Representerar den otillåtna felkoden.
InternalCommunicationFailed	Det gick inte att ange felkoden för intern kommunikation.
InternalServerError	Representerar felkoden för den interna servern.
InvalidArgument	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	Representerar den ogiltiga felkoden för begäran.
NotAllowed	Representerar den felkod som inte tillåts.
NotFound	Representerar felkoden som inte hittades.
PipelineError	Representerar felkoden för pipelinefel.
ServiceUnavailable	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	Representerar felkoden för för många begäranden.
Unauthorized	Representerar den obehöriga felkoden.
UnprocessableEntity	Representerar felkoden för entitetsfel som inte kan bearbetas.
UnsupportedMediaType	Representerar felkoden för medietypen som inte stöds.

File

Objekt

Fil

Name	Typ	Description
createdDateTime	string (date-time)	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 (uri)	Platsen för den här entiteten.

FileKind

Uppräkning

FileKind

Värde	Description
AcousticDataArchive	Typ av data är akustiskt dataarkiv.
AcousticDataTranscriptionV2	Typ av data är akustisk dataranskription v2.
Audio	Typ av data är ljud.
DatasetReport	Typ av data är datamängdsrapport.
EvaluationDetails	Typ av data är utvärderingsinformation.
LanguageData	Typ av data är språkdata.
ModelReport	Typ av data är modellrapport.
OutputFormattingData	Typ av data är indatafilen för utdataformatering.
PronunciationData	Typ av data är uttalsdata.
Transcription	Typ av data är transkription.
TranscriptionReport	Typ av data är transkriptionsrapport.

FileLinks

Objekt

FileLinks

Name	Typ	Description
contentUrl	string (uri)	Url:en för att hämta innehållet i den här filen.

FileProperties

Objekt

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 (int64)	Storleken på data i byte.

InnerError

Objekt

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 (nyckel värde par), 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

Objekt

Sidnumrerade filer

Name	Typ	Description
@nextLink	string (uri)	En länk till nästa uppsättning sidnumrerade resultat om det finns fler tillgängliga entiteter. 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.

Name

Typ

Description

@nextLink

string (uri)

En länk till nästa uppsättning sidnumrerade resultat om det finns fler tillgängliga entiteter. 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.

Dela via

Transcriptions - List Files

URI-parametrar

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Get all files

Exempelbegäran

Exempelsvar

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

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

Ytterligare resurser