ingest

What an ingest job reports about the recording it read.

The ingest container reads the runner's copy of a recording, after the pseudonymisation rule, and writes one document: the SHA-256 of its header and its annotations. The runner uploads the document, and the platform checks the header against the one registered and stores the annotations as events.

IngestAnnotation pydantic-model

Bases: BaseModel

One EDF+ annotation, in milliseconds from the recording's start.

Config:

• extra: forbid
• frozen: True

Fields:

• start_ms (int)
• end_ms (int)
• label (EventLabel)
• text (str | None)

label pydantic-field

The platform's label for the text, or Unknown when none matches.

text = None pydantic-field

The text as written, when no label matched and the job keeps text. Absent for a recording in an organisation's bucket, whose free text stays at the site.

IngestDocument pydantic-model

Bases: BaseModel

The document an ingest job writes about the recording it read.

Config:

• extra: forbid

Fields:

• format_version (Literal[1])
• header_sha256 (str)
• annotations (list[IngestAnnotation])

header_sha256 pydantic-field

The SHA-256 of the header as the container read it: the fixed header and every signal header, after the pseudonymisation rule.