Share via

TranscribedPhrase Class

A transcribed phrase.

Constructor

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

Variables

Name Description
channel
int

The 0-based channel index. Only present if channel separation is enabled.
speaker
int

A unique integer number that is assigned to each speaker detected in the audio without particular order. Only present if speaker diarization is enabled.
offset_milliseconds
int

The start offset of the phrase in milliseconds. Required.
duration_milliseconds
int

The duration of the phrase in milliseconds. Required.
text
str

The transcribed text of the phrase. Required.
words
list[TranscribedWord]

The words that make up the phrase. Only present if word-level timestamps are enabled.
locale
str

The locale of the phrase.
confidence
float

The confidence value for the phrase. Required.

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

channel

The 0-based channel index. Only present if channel separation is enabled.

channel: int | None

confidence

The confidence value for the phrase. Required.

confidence: float

duration_milliseconds

The duration of the phrase in milliseconds. Required.

duration_milliseconds: int

locale

The locale of the phrase.

locale: str | None

offset_milliseconds

The start offset of the phrase in milliseconds. Required.

offset_milliseconds: int

speaker

A unique integer number that is assigned to each speaker detected in the audio without particular order. Only present if speaker diarization is enabled.

speaker: int | None

text

The transcribed text of the phrase. Required.

text: str

words

The words that make up the phrase. Only present if word-level timestamps are enabled.

words: list['_models.TranscribedWord'] | None