Transcriptions - Get

Service:: Azure AI Services

API-versie:: v3.2-preview.2

Hiermee haalt u de transcriptie op die is geïdentificeerd door de opgegeven id.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	De id van de transcriptie.

Antwoorden

Name	Type	Description
200 OK	Transcription	OK Kopteksten Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

Transcription

Kopteksten

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get a transcription

Voorbeeldaanvraag

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683

Voorbeeldrespons

Statuscode:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
  },
  "properties": {
    "diarizationEnabled": false,
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "duration": "PT42S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  }
}

Definities

Name	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	Interpunctiemodus
Status	Toestand
Transcription	Transcriptie
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptieProperties

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde	Description
InvalidParameterValue	Ongeldige parameterwaarde.
InvalidRequestBodyFormat	Ongeldige indeling voor de hoofdtekst van de aanvraag.
EmptyRequest	Lege aanvraag.
MissingInputRecords	Ontbrekende invoerrecords.
InvalidDocument	Ongeldig document.
ModelVersionIncorrect	Modelversie onjuist.
InvalidDocumentBatch	Ongeldige documentbatch.
UnsupportedLanguageCode	Niet-ondersteunde taalcode.
DataImportFailed	Het importeren van gegevens is mislukt.
InUseViolation	Schending van gebruik.
InvalidLocale	Ongeldige landinstelling.
InvalidBaseModel	Ongeldig basismodel.
InvalidAdaptationMapping	Ongeldige aanpassingstoewijzing.
InvalidDataset	Ongeldige gegevensset.
InvalidTest	Ongeldige test.
FailedDataset	Mislukte gegevensset.
InvalidModel	Ongeldig model.
InvalidTranscription	Ongeldige transcriptie.
InvalidPayload	Ongeldige nettolading.
InvalidParameter	Ongeldige parameter.
EndpointWithoutLogging	Eindpunt zonder logboekregistratie.
InvalidPermissions	Ongeldige machtigingen.
InvalidPrerequisite	Ongeldige vereiste.
InvalidProductId	Ongeldige product-id.
InvalidSubscription	Ongeldig abonnement.
InvalidProject	Ongeldig project.
InvalidProjectKind	Ongeldig projecttype.
InvalidRecordingsUri	Ongeldige opnamen-URI.
OnlyOneOfUrlsOrContainerOrDataset	Slechts één van url's of containers of gegevenssets.
ExceededNumberOfRecordingsUris	Het aantal opnamen is overschreden.
ModelMismatch	Model komt niet overeen.
ProjectGenderMismatch	Project geslacht komt niet overeen.
ModelDeprecated	Model afgeschaft.
ModelExists	Het model bestaat.
ModelNotDeployable	Model kan niet worden geïmplementeerd.
EndpointNotUpdatable	Eindpunt kan niet worden bijgewerkt.
SingleDefaultEndpoint	Eén standaardeindpunt.
EndpointCannotBeDefault	Eindpunt kan niet standaard zijn.
InvalidModelUri	Ongeldige model-URI.
SubscriptionNotFound	Abonnement is niet gevonden.
QuotaViolation	Quotumschending.
UnsupportedDelta	Niet-ondersteunde delta.
UnsupportedFilter	Niet-ondersteund filter.
UnsupportedPagination	Niet-ondersteunde paginering.
UnsupportedDynamicConfiguration	Niet-ondersteunde dynamische configuratie.
UnsupportedOrderBy	Niet-ondersteunde volgorde door.
NoUtf8WithBom	Geen utf8 met bom.
ModelDeploymentNotCompleteState	Modelimplementatie is niet voltooid.
SkuLimitsExist	Er bestaan SKU-limieten.
DeployingFailedModel	Het implementeren van een mislukt model.
UnsupportedTimeRange	Niet-ondersteund tijdsbereik.
InvalidLogDate	Ongeldige logboekdatum.
InvalidLogId	Ongeldige logboek-id.
InvalidLogStartTime	Ongeldige begintijd voor logboeken.
InvalidLogEndTime	Ongeldige eindtijd van logboek.
InvalidTopForLogs	Ongeldig bovenaan voor logboeken.
InvalidSkipTokenForLogs	Ongeldig skip-token voor logboeken.
DeleteNotAllowed	Verwijderen is niet toegestaan.
Forbidden	Verboden.
DeployNotAllowed	Implementeren is niet toegestaan.
UnexpectedError	Onverwachte fout.
InvalidCollection	Ongeldige verzameling.
InvalidCallbackUri	Ongeldige callback-URI.
InvalidSasValidityDuration	Ongeldige geldigheidsduur van SAS.
InaccessibleCustomerStorage	Niet-toegankelijke opslag van klanten.
UnsupportedClassBasedAdaptation	Niet-ondersteunde aanpassing op basis van klassen.
InvalidWebHookEventKind	Ongeldig gebeurtenistype webhook.
InvalidTimeToLive	Ongeldige time to live.
InvalidSourceAzureResourceId	Ongeldige azure-bronresource-id.
ModelCopyOperationExists	Er bestaat een modelkopiebewerking.

DiarizationProperties

Object

DiarizationProperties

Name	Type	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Object

DiarizationSpeakersProperties

Name	Type	Description
maxCount	integer (int32) minimum: 1	Het maximum aantal sprekers voor diarisatie. Moet kleiner zijn dan 36 en groter dan of gelijk aan de minSpeakers-eigenschap.
minCount	integer (int32) minimum: 1	Een hint voor het minimale aantal sprekers voor diarisatie. Moet kleiner zijn dan of gelijk zijn aan de eigenschap maxSpeakers.

EntityError

Object

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

EntityReference

Object

EntityReference

Name	Type	Description
self	string (uri)	De locatie van de entiteit waarnaar wordt verwezen.

Error

Object

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Inventarisatie

ErrorCode

Waarde	Description
InvalidRequest	De foutcode van de ongeldige aanvraag vertegenwoordigt.
InvalidArgument	De foutcode van het ongeldige argument vertegenwoordigt.
InternalServerError	De foutcode van de interne server vertegenwoordigt.
ServiceUnavailable	Vertegenwoordiging van de service niet-beschikbare foutcode.
NotFound	De foutcode wordt niet gevonden.
PipelineError	De foutcode van de pijplijnfout weergeven.
Conflict	Vertegenwoordiging van de conflictfoutcode.
InternalCommunicationFailed	De foutcode voor de interne communicatie is mislukt.
Forbidden	Vertegenwoordiging van de verboden foutcode.
NotAllowed	Vertegenwoordiging van de niet-toegestane foutcode.
Unauthorized	Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnsupportedMediaType	De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.
TooManyRequests	De foutcode voor te veel aanvragen vertegenwoordigt.
UnprocessableEntity	De foutcode van de niet-verwerkte entiteit vertegenwoordigt.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde opsomming van foutcodes.
details	object	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

LanguageIdentificationMode

Inventarisatie

LanguageIdentificationMode

Waarde	Description
Continuous	Continue taalidentificatie (standaard).
Single	Identificatie van één taal.

LanguageIdentificationProperties

Object

LanguageIdentificationProperties

Name	Type	Default value	Description
candidateLocales	string[]		De landinstellingen van de kandidaat voor taalidentificatie (bijvoorbeeld ["en-US", "de-DE", "es-ES"]). Minimaal 2 en maximaal 10 kandidaatlandinstellingen, inclusief de belangrijkste landinstelling voor de transcriptie, worden ondersteund.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode De modus die wordt gebruikt voor taalidentificatie.
speechModelMapping	<string, EntityReference>		Een optionele toewijzing van landinstellingen aan spraakmodelentiteiten. Als er geen model wordt gegeven voor een landinstelling, wordt het standaardbasismodel gebruikt. Sleutels moeten landinstellingen zijn die zijn opgenomen in de kandidaat-landinstellingen. Waarden zijn entiteiten voor modellen van de respectieve landinstellingen.

ProfanityFilterMode

Inventarisatie

ProfanityFilterMode

Waarde	Description
None	Filter op grof taalgebruik uitschakelen.
Removed	Verwijder grof taalgebruik.
Tags	XML-tags toevoegen</Grof taalgebruik>
Masked	Masker de grofheid met * behalve de eerste letter, bijvoorbeeld f**

PunctuationMode

Inventarisatie

Interpunctiemodus

Waarde	Description
None	Geen interpunctie.
Dictated	Alleen dicteerde interpunctiemarkeringen, dat wil zeggen expliciete interpunctie.
Automatic	Automatische interpunctie.
DictatedAndAutomatic	Dicteerde interpunctiemarkeringen of automatische interpunctie.

Status

Inventarisatie

Toestand

Waarde	Description
NotStarted	De langdurige bewerking is nog niet gestart.
Running	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	De langdurige bewerking is voltooid.
Failed	De langdurige bewerking is mislukt.

Transcription

Object

Transcriptie

Name	Type	Description
contentContainerUrl	string (uri)	Een URL voor een Azure Blob-container die de audiobestanden bevat. Een container mag maximaal 5 GB en maximaal 10000 blobs hebben. De maximale grootte voor een blob is 2,5 GB. Container-SAS moet machtigingen 'r' (lezen) en 'l' (lijst) bevatten. Deze eigenschap wordt niet geretourneerd in een antwoord.
contentUrls	string[] (uri)	Een lijst met inhouds-URL's voor het ophalen van audiobestanden om te transcriberen. Maximaal 1000 URL's zijn toegestaan. Deze eigenschap wordt niet geretourneerd in een antwoord.
createdDateTime	string (date-time)	Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximale toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
dataset	EntityReference	EntityReference
description	string	De beschrijving van het object.
displayName	string minLength: 1	De weergavenaam van het object.
lastActionDateTime	string (date-time)	Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriptionLinks
locale	string minLength: 1	De landinstelling van de ingesloten gegevens. Als taalidentificatie wordt gebruikt, wordt deze landinstelling gebruikt om spraak te transcriberen waarvoor geen taal kan worden gedetecteerd.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptieProperties
self	string (uri)	De locatie van deze entiteit.
status	Status	Toestand De huidige status van de API beschrijven

TranscriptionLinks

Object

TranscriptionLinks

Name	Type	Description
files	string (uri)	De locatie om alle bestanden van deze entiteit op te halen. Zie de bewerking 'Transcriptions_ListFiles' voor meer informatie.

TranscriptionProperties

Object

TranscriptieProperties

Name	Type	Description
channels	integer[] (int32)	Een verzameling van de aangevraagde kanaalnummers. In het standaardscenario worden de kanalen 0 en 1 overwogen.
destinationContainerUrl	string (uri)	De aangevraagde doelcontainer. Opmerkingen Wanneer een doelcontainer wordt gebruikt in combinatie met een `timeToLive`, worden de metagegevens van een transcriptie normaal verwijderd, maar blijven de gegevens die zijn opgeslagen in de doelcontainer, inclusief transcriptieresultaten, ongewijzigd, omdat er geen verwijdermachtigingen vereist zijn voor deze container. Als u automatische opschoning wilt ondersteunen, configureert u de levensduur van de blob in de container of gebruikt u BYOS (Bring Your Own Storage) in plaats van `destinationContainerUrl`, waar blobs kunnen worden opgeschoond.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Een waarde die aangeeft of diarisatie (sprekeridentificatie) wordt aangevraagd. De standaardwaarde is `false`. Als dit veld is ingesteld op waar en het verbeterde diarisatiesysteem is geconfigureerd door `DiarizationProperties`op te geven, biedt het verbeterde diarisatiesysteem diarisatie voor een configureerbaar bereik van luidsprekers. Als dit veld is ingesteld op true en het verbeterde diarisatiesysteem niet is ingeschakeld (geen `DiarizationProperties`opgeven), maakt het basis diarisatiesysteem onderscheid tussen maximaal twee luidsprekers. Er worden geen extra kosten in rekening gebracht voor de basis-diarisatie. Het eenvoudige diarisatiesysteem is afgeschaft en wordt verwijderd in de volgende primaire versie van de API. Deze `diarizationEnabled` instelling wordt ook verwijderd.
displayFormWordLevelTimestampsEnabled	boolean	Een waarde die aangeeft of tijdstempels op woordniveau voor het weergaveformulier worden aangevraagd. De standaardwaarde is `false`.
duration	string	De duur van de transcriptie. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	Het e-mailadres waarnaar e-mailmeldingen moeten worden verzonden voor het geval de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modus van grof filteren.
punctuationMode	PunctuationMode	Interpunctiemodus De modus die wordt gebruikt voor interpunctie.
timeToLive	string	Hoe lang de transcriptie in het systeem wordt bewaard nadat deze is voltooid. Zodra de transcriptie de tijd tot leven heeft bereikt na voltooiing (geslaagd of mislukt), wordt deze automatisch verwijderd. Als u deze waarde niet instelt of op 0 instelt, wordt automatisch verwijderen uitgeschakeld. De langste ondersteunde duur is 31 dagen. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Een waarde die aangeeft of tijdstempels op woordniveau worden aangevraagd. De standaardwaarde is `false`.

Transcriptions - Get

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Get a transcription

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Opmerkingen