Transcription Events¶

events ¶

Classes¶

Start ¶

Start(*, utterance_id: str, started_at: float)

Indicates the start of a transcription utterance.

Attributes:

Name	Type	Description
`utterance_id`		Unique ID for this utterance.
`started_at`		Absolute timestamp when transcription started (UNIX timestamp).

Source code in audex/lib/transcription/events.py

def __init__(self, *, utterance_id: str, started_at: float) -> None:
    self.utterance_id = utterance_id
    self.started_at = started_at

Delta ¶

Delta(*, utterance_id: str, offset_begin: float, offset_end: float | None, text: str, interim: bool)

Delta event representing a partial transcription update.

Attributes:

Name	Type	Description
`utterance_id`		ID of the utterance this delta belongs to.
`offset_begin`		Start offset from utterance start (in seconds).
`offset_end`		End offset from utterance start (in seconds, None for interim).
`text`		The transcribed text for the segment.
`interim`		Whether this is interim (True) or final (False).

Source code in audex/lib/transcription/events.py

def __init__(
    self,
    *,
    utterance_id: str,
    offset_begin: float,
    offset_end: float | None,
    text: str,
    interim: bool,
) -> None:
    self.utterance_id = utterance_id
    self.offset_begin = offset_begin
    self.offset_end = offset_end
    self.text = text
    self.interim = interim

Done ¶

Done(*, utterance_id: str, ended_at: float)

Indicates the completion of a transcription utterance.

Attributes:

Name	Type	Description
`utterance_id`		ID of the completed utterance.
`ended_at`		Absolute timestamp when transcription ended (UNIX timestamp).

Source code in audex/lib/transcription/events.py

def __init__(self, *, utterance_id: str, ended_at: float) -> None:
    self.utterance_id = utterance_id
    self.ended_at = ended_at

options: show_root_heading: true show_source: true heading_level: 2 members_order: source show_signature_annotations: true separate_signature: true