Transcriptions - Update

Referens

Tjänst:: Azure AI Services

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

Uppdaterar den föränderliga informationen om transkriptionen som identifieras av dess ID.

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

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.

Begärandetext

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Description
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description	string	Beskrivningen av objektet.
displayName	string	Namnet på objektet.
project	EntityReference	EntityReference

Svar

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

Name

Typ

Description

200 OK

Transcription

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

Update a transcription

Exempelbegäran

HTTP

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

{
  "displayName": "Updated transcription name",
  "description": "Updated transcription description",
  "customProperties": {
    "key": "value"
  }
}

Exempelsvar

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

Definitioner

Name	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersEgenskaper
EntityError	EntityError
EntityReference	EntityReference
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	InterpunktionMode
Status	Status
Transcription	Transkription
TranscriptionLinks	TranskriptionLänkar
TranscriptionProperties	TranskriptionEgenskaper
TranscriptionUpdate	TranskriptionUpdate

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.

DiarizationProperties

Objekt

DiarizationProperties

Name	Typ	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersEgenskaper

DiarizationSpeakersProperties

Objekt

DiarizationSpeakersEgenskaper

Name	Typ	Description
maxCount	integer (int32) minimum: 1	Det maximala antalet talare för diarisering. Måste vara mindre än 36 och större än eller lika med egenskapen minSpeakers.
minCount	integer (int32) minimum: 1	Ett tips för det minsta antalet talare för diarisering. Måste vara mindre än eller lika med egenskapen maxSpeakers.

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Koden för det här felet.
message	string	Meddelandet för det här felet.

EntityReference

Objekt

EntityReference

Name	Typ	Description
self	string (uri)	Platsen för den refererade entiteten.

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.

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.

LanguageIdentificationMode

Uppräkning

LanguageIdentificationMode

Värde	Description
Continuous	Kontinuerlig språkidentifiering (standard).
Single	Enkel språkidentifiering.

LanguageIdentificationProperties

Objekt

LanguageIdentificationProperties

Name	Typ	Standardvärde	Description
candidateLocales	string[]		Språkidentifieringens kandidatspråk (till exempel ["en-US", "de-DE", "es-ES"]). Minst 2 och högst 10 kandidatspråk, inklusive huvudspråket för transkriptionen, stöds.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Det läge som används för språkidentifiering.
speechModelMapping	<string, EntityReference>		En valfri mappning av nationella inställningar till talmodellentiteter. Om ingen modell anges för ett språk används standardbasmodellen. Nycklar måste vara nationella inställningar som finns i kandidatspråket, värden är entiteter för modeller av respektive nationella inställningar.

ProfanityFilterMode

Uppräkning

ProfanityFilterMode

Värde	Description
Masked	Maskera svordomarna med * förutom den första bokstaven, t.ex. f***
None	Inaktivera filtrering av svordomar.
Removed	Ta bort svordomar.
Tags	Lägg till XML-taggar för "svordomar"</Profanity>

PunctuationMode

Uppräkning

InterpunktionMode

Värde	Description
Automatic	Automatisk skiljetecken.
Dictated	Endast dikterade skiljetecken, dvs. explicit skiljetecken.
DictatedAndAutomatic	Dikterade skiljetecken eller automatisk skiljetecken.
None	Ingen skiljetecken.

Status

Uppräkning

Status

Värde	Description
Failed	Den tidskrävande åtgärden misslyckades.
NotStarted	Den tidskrävande åtgärden har ännu inte startats.
Running	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	Den tidskrävande åtgärden har slutförts.

Transcription

Objekt

Transkription

Name	Typ	Description
contentContainerUrl	string (uri)	En URL för en Azure-blobcontainer som innehåller ljudfilerna. En container får ha en maximal storlek på 5 GB och högst 1 0000 blobar. Den maximala storleken för en blob är 2,5 GB. Container-SAS ska innehålla behörigheterna "r" (läs) och "l" (lista). Den här egenskapen returneras inte i ett svar.
contentUrls	string[] (uri)	En lista över innehålls-URL:er för att få ljudfiler att transkribera. Upp till 1 000 URL:er tillåts. Den här egenskapen returneras inte i ett svar.
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
dataset	EntityReference	EntityReference
description	string	Beskrivningen av objektet.
displayName	string minLength: 1	Objektets visningsnamn.
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranskriptionLänkar
locale	string minLength: 1	Nationella inställningar för inneslutna data. Om språkidentifiering används används det här språket för att transkribera tal som inget språk kunde identifieras för.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranskriptionEgenskaper
self	string (uri)	Platsen för den här entiteten.
status	Status	Status Beskriva api:ets aktuella tillstånd

TranscriptionLinks

Objekt

TranskriptionLänkar

Name	Typ	Description
files	string (uri)	Platsen där du kan hämta alla filer för den här entiteten. Mer information finns i åtgärden "Transcriptions_ListFiles".

TranscriptionProperties

Objekt

TranskriptionEgenskaper

Name	Typ	Description
channels	integer[] (int32)	En samling av de begärda kanalnumren. I standardfallet beaktas kanalerna 0 och 1.
destinationContainerUrl	string (uri)	Den begärda målcontainern. Anmärkningar När en målcontainer används i kombination med en `timeToLive`tas metadata för en transkription bort normalt, men data som lagras i målcontainern, inklusive transkriptionsresultat, förblir orörda eftersom inga borttagningsbehörigheter krävs för den här containern. Om du vill ha stöd för automatisk rensning konfigurerar du antingen bloblivslängder i containern eller använder Byos (Bring Your Own Storage) i stället för `destinationContainerUrl`, där blobar kan rensas.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Ett värde som anger om diarization (talaridentifiering) begärs. Standardvärdet är `false`. Om det här fältet är inställt på sant och det förbättrade diariseringssystemet konfigureras genom att ange `DiarizationProperties`ger det förbättrade diariseringssystemet diarisering för ett konfigurerbart antal talare. Om det här fältet är inställt på sant och det förbättrade diariseringssystemet inte är aktiverat (anger inte `DiarizationProperties`) skiljer det grundläggande diariseringssystemet mellan upp till två talare. Inga extra avgifter tillämpas för den grundläggande diariseringen. Det grundläggande diariseringssystemet är inaktuellt och tas bort i nästa huvudversion av API:et. Den här `diarizationEnabled` inställningen tas också bort.
displayFormWordLevelTimestampsEnabled	boolean	Ett värde som anger om tidsstämplar på ordnivå för visningsformuläret begärs. Standardvärdet är `false`.
duration	string	Transkriptionens varaktighet. Varaktigheten kodas som ISO 8601-varaktighet ("PnYnMnDTnHnMnS", se https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	E-postadressen som e-postaviseringar ska skickas till om åtgärden slutförs. Värdet tas bort när e-postmeddelandet har skickats.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Läge för svordomsfiltrering.
punctuationMode	PunctuationMode	InterpunktionMode Det läge som används för skiljetecken.
timeToLive	string	Hur länge transkriptionen ska behållas i systemet när den har slutförts. När transkriptionen når tiden till live efter slutförandet (lyckades eller misslyckades) tas den bort automatiskt. Om du inte anger det här värdet eller anger det till 0 inaktiveras automatisk borttagning. Den längsta varaktigheten som stöds är 31 dagar. Varaktigheten kodas som ISO 8601-varaktighet ("PnYnMnDTnHnMnS", se https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Ett värde som anger om tidsstämplar på ordnivå begärs. Standardvärdet är `false`.

TranscriptionUpdate

Objekt

TranskriptionUpdate

Name	Typ	Description
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description	string	Beskrivningen av objektet.
displayName	string	Namnet på objektet.
project	EntityReference	EntityReference

Dela via

Transcriptions - Update

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Update a transcription

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Anmärkningar

TranscriptionUpdate

Ytterligare resurser