medkit.audio.transcription.transcribed_document
medkit.audio.transcription.transcribed_document#
Classes:
|
Subclass for |
- class TranscribedDocument(text, text_spans_to_audio_spans, audio_doc_id, anns=None, metadata=None, uid=None)[source]#
Subclass for
TextDocumentinstances generated by audio transcription.- Variables
uid (str) – Document identifier.
text – The full transcribed text.
text_spans_to_audio_spans (Dict[medkit.core.text.span.Span, medkit.core.audio.span.Span]) – Mapping between text characters spans in this document and corresponding audio spans in the original audio.
audio_doc_id (Optional[str]) – Id of the original
AudioDocumentthat was transcribed, if known.anns (medkit.core.text.annotation_container.TextAnnotationContainer) – Annotations of the document.
metadata (Dict[str, Any]) – Document metadata.
raw_segment (medkit.core.text.annotation.Segment) – Auto-generated segment containing the raw full transcribed text.
Methods:
from_dict(doc_dict)Create a TranscribedDocument from a dict
get_containing_audio_spans(text_ann_spans)Return the audio spans used to transcribe the text referenced by a text annotation.
- get_containing_audio_spans(text_ann_spans)[source]#
Return the audio spans used to transcribe the text referenced by a text annotation.
For instance, if the audio ranging from 1.0 to 20.0 seconds is transcribed to some text ranging from character 10 to 56 in the transcribed document, and then a text annotation is created referencing the span 15 to 25, then the containing audio span will be the one ranging from 1.0 to 20.0 seconds.
Note that some text annotations maybe be contained in more that one audio spans.
- Parameters
text_ann_spans (
List[AnySpan]) – Text spans of a text annotation referencing some characters in the transcribed document.- Return type
List[Span]- Returns
List[AudioSpan] – Audio spans used to transcribe the text referenced by the spans of text_ann.