Sign in

v10

latestSwagger 2.02026-07-137784220.8 KB
Custom Speech transcriptions:

Updates the mutable details of the transcription identified by its ID.

patch/transcriptions/{id}

Path parameters

idstring uuid required

The identifier of the transcription.

Request body

displayNamestring

The name of the object.

descriptionstring

The description of the object.

customPropertiesobject

The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.

Response

OK

selfstring uri

The location of this entity.

contentUrlsstring[]

A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response.

contentContainerUrlstring uri

A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response.

localestring required

The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.

displayNamestring required

The display name of the object.

descriptionstring

The description of the object.

customPropertiesobject

The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.

lastActionDateTimestring date-time

The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed'

Describe the current state of the API

createdDateTimestring date-time

The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).