Share via

TranscriptionOptions Class

Metadata for a transcription request.

Constructor

TranscriptionOptions(*args: Any, **kwargs: Any)

Variables

Name Description
audio_url
str

The URL of the audio to be transcribed. The audio must be shorter than 2 hours in audio duration and smaller than 250 MB in size. If both Audio and AudioUrl are provided, Audio is used.
locales
list[str]

A list of possible locales for the transcription. If not specified, the locale of the speech in the audio is detected automatically from all supported locales.
models
dict[str, str]

Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.
profanity_filter_mode
str or ProfanityFilterMode

Mode of profanity filtering. Known values are: "None", "Removed", "Tags", and "Masked".
diarization_options
TranscriptionDiarizationOptions

Mode of diarization.
active_channels
list[int]

The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.
enhanced_mode
EnhancedModeProperties

Enhanced mode properties.
phrase_list
PhraseListProperties

Phrase list properties.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

active_channels

The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.

active_channels: list[int] | None

audio_url

The URL of the audio to be transcribed. The audio must be shorter than 2 hours in audio duration and smaller than 250 MB in size. If both Audio and AudioUrl are provided, Audio is used.

audio_url: str | None

diarization_options

Mode of diarization.

diarization_options: _models.TranscriptionDiarizationOptions | None

enhanced_mode

Enhanced mode properties.

enhanced_mode: _models.EnhancedModeProperties | None

locales

A list of possible locales for the transcription. If not specified, the locale of the speech in the audio is detected automatically from all supported locales.

locales: list[str] | None

models

Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.

models: dict[str, str] | None

phrase_list

Phrase list properties.

phrase_list: _models.PhraseListProperties | None

profanity_filter_mode

"None", "Removed", "Tags", and "Masked".

profanity_filter_mode: str | _models.ProfanityFilterMode | None