medkit.core.document

Classes

Document

Base protocol for document classes of any modality (text, audio, etc).

Module Contents

class medkit.core.document.Document

Bases: typing_extensions.Protocol[medkit.core.annotation.AnnotationType]

Base protocol for document classes of any modality (text, audio, etc).

Documents can contain Annotation objects.

Attributes:

uid:

Unique identifier of the document

anns:

Annotations of the document, stored in an AnnotationContainer for easier access (can be subclassed to add modality-specific features).

attrs:

Attributes of the document, stored in an :class: ~medkit.core.attribute_container.AttributeContainer for easier access

raw_segment:

Auto-generated segment containing the full unprocessed document.

uid: str

anns: medkit.core.annotation_container.AnnotationContainer[medkit.core.annotation.AnnotationType]

attrs: medkit.core.attribute_container.AttributeContainer

raw_segment: medkit.core.annotation.AnnotationType