Transcriptions - Update

  • Referens
Tjänst:
Azure AI Services
API-version:
v3.2-preview.2

Uppdateringar de föränderliga detaljerna för 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 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

Update a transcription

Exempelbegäran

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

LanguageIdentificationEgenskaper
ProfanityFilterMode

ProfanityFilterMode
PunctuationMode

InterpunktionMode
Status

Status
Transcription

Transkription
TranscriptionLinks

TranskriptionLänkar
TranscriptionProperties

TranskriptionEgenskaper
TranscriptionUpdate

TranskriptionUpdate

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.
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.
ModelCopyOperationExists

string

Modellkopieringsåtgärden finns.
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.

DiarizationProperties

DiarizationProperties

Name Typ Description
speakers

DiarizationSpeakersProperties

DiarizationSpeakersEgenskaper

DiarizationSpeakersProperties

DiarizationSpeakersEgenskaper

Name Typ Description
maxCount

integer

Det maximala antalet talare för diarisering. Måste vara mindre än 36 och större än eller lika med egenskapen minSpeakers.
minCount

integer

Ett tips för det minsta antalet talare för diarisering. Måste vara mindre än eller lika med egenskapen maxSpeakers.

EntityError

EntityError

Name Typ Description
code

string

Koden för det här felet.
message

string

Meddelandet för det här felet.

EntityReference

EntityReference

Name Typ Description
self

string

Platsen för den refererade entiteten.

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.

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.

LanguageIdentificationMode

LanguageIdentificationMode

Name Typ Description
Continuous

string

Kontinuerlig språkidentifiering (standard).
Single

string

Enkel språkidentifiering.

LanguageIdentificationProperties

LanguageIdentificationEgenskaper

Name Typ Standardvärde Description
candidateLocales

string[]

Kandidatspråken för språkidentifiering (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 språk.

ProfanityFilterMode

ProfanityFilterMode

Name Typ Description
Masked

string

Maskera svordomarna med * utom den första bokstaven, t.ex. f***
None

string

Inaktivera svordomsfiltrering.
Removed

string

Ta bort svordomar.
Tags

string

Lägg till XML-taggar</svordomar för "svordomar">

PunctuationMode

InterpunktionMode

Name Typ Description
Automatic

string

Automatisk skiljetecken.
Dictated

string

Endast dikterade skiljetecken, d.v.s. explicit skiljetecken.
DictatedAndAutomatic

string

Dikterade skiljetecken eller automatisk skiljetecken.
None

string

Ingen skiljetecken.

Status

Status

Name Typ Description
Failed

string

Den långvariga åtgärden misslyckades.
NotStarted

string

Den långvariga åtgärden har ännu inte startats.
Running

string

Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded

string

Den långvariga åtgärden har slutförts.

Transcription

Transkription

Name Typ Description
contentContainerUrl

string

En URL för en Azure Blob-container som innehåller ljudfilerna. En container får ha en maximal storlek på 5 GB och ett maximalt antal 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[]

En lista med innehålls-URL:ar för att hämta ljudfiler att transkribera. Upp till 1 000 url:ar tillåts. Den här egenskapen returneras inte i ett svar.
createdDateTime

string

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

Visningsnamnet för objektet.
lastActionDateTime

string

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

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

Platsen för den här entiteten.
status

Status

Status
Beskriva api:ets aktuella tillstånd

TranskriptionLänkar

Name Typ Description
files

string

Platsen för att hämta alla filer i den här entiteten. Mer information finns i åtgärden "Transcriptions_ListFiles".

TranscriptionProperties

TranskriptionEgenskaper

Name Typ Description
channels

integer[]

En samling av de begärda kanalnumren. I standardfallet beaktas kanalerna 0 och 1.
destinationContainerUrl

string

Den begärda målcontainern.

Kommentarer

När en målcontainer används i kombination med en timeToLivetas metadata för en transkription bort normalt, men de 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ängden för 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 DiarizationPropertiesange , ger det förbättrade diariseringssystemet diarisering för ett konfigurerbart antal högtalare. Om det här fältet är inställt på sant och det förbättrade diariseringssystemet inte är aktiverat (anger DiarizationPropertiesinte) 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

LanguageIdentificationEgenskaper
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 att leva efter slutförandet (lyckad eller misslyckad) tas den bort automatiskt. Om du inte anger det här värdet eller ställer in det på 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

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