← Back to API reference

neuralset.events.etypes.BaseText

pydantic model neuralset.events.etypes.BaseText

Base class for text-based events.

Parameters:

• language (str, optional) – ISO language code (e.g., ‘en’, ‘fr’). Default: “”

• text (str) – The text content (must be non-empty)

• context (str, optional) – Contextual information (e.g., preceding words). Default: “”

• modality (Literal["heard", "read", "imagined", "typed", "written", "caption"], optional) – Modality of the text event. Default: None

Raises:

ValidationError – If text is empty (min_length=1)

Fields:

• context (str)

• language (str)

• modality (Literal['heard', 'read', 'imagined', 'typed', 'written', 'caption'] | None)

• text (str)

field text: str [Required]

field language: str = ''

field context: str = ''

field modality: Literal['heard', 'read', 'imagined', 'typed', 'written', 'caption'] | None = None

requirements: tp.ClassVar[tuple[str, ...]] = ()

type: tp.ClassVar[str] = 'BaseText'

← Back to API reference