ontocast.onto.section_models¶
Pydantic models for document outlines and section spans.
Attributes¶
CANONICAL_SECTION_LABELS = canonical_labels(get_default_section_schema())
module-attribute
¶
__all__ = ['CANONICAL_SECTION_LABELS', 'DocumentOutline', 'HeadingNode', 'LabelEvidence', 'OutlineLabelReport', 'SectionSpan']
module-attribute
¶
Classes¶
DocumentOutline
¶
Bases: BasePydanticModel
Ordered headings detected in a document, with the document length.
Source code in ontocast/onto/section_models.py
HeadingNode
¶
Bases: BasePydanticModel
One detected heading in the document outline.
Attributes:
| Name | Type | Description |
|---|---|---|
text |
str
|
Raw heading line as it appears in the document text. |
normalised |
str
|
Heading text after decoration/numbering stripping. |
start |
int
|
Character offset of the heading line itself. |
body_start |
int
|
Character offset just past the heading line. |
level |
int
|
Markdown heading depth (1 = top). Docling reports a flat level for PDF conversions, so levels place a heading only in documents whose levels vary. |
number |
str | None
|
The heading's section number ("2.1", "II", "A.2"), if any. |
parent |
int | None
|
Index in the outline of the heading this one sits under. |
tree_placed |
bool
|
Whether numbering or markdown levels place this heading;
|
sectionlike |
bool
|
Whether the heading reads as a generic section name rather than a descriptive subsection title or a document title. |
label |
str | None
|
Canonical section label, when resolved. |
source |
SectionLabelSource
|
How |
strength |
LabelStrength
|
Whether |
Source code in ontocast/onto/section_models.py
Attributes¶
body_start
instance-attribute
¶
label = None
class-attribute
instance-attribute
¶
level = 1
class-attribute
instance-attribute
¶
normalised
instance-attribute
¶
number = None
class-attribute
instance-attribute
¶
parent = None
class-attribute
instance-attribute
¶
sectionlike = True
class-attribute
instance-attribute
¶
source = SectionLabelSource.OUTLINE_UNRESOLVED
class-attribute
instance-attribute
¶
start
instance-attribute
¶
strength = LabelStrength.WEAK
class-attribute
instance-attribute
¶
text
instance-attribute
¶
tree_placed = False
class-attribute
instance-attribute
¶
LabelEvidence
¶
Bases: BasePydanticModel
One tier's vote on a unit's section label.
Every tier that speaks adds one; the unit's label is the strongest vote,
and between equals the heading's (see ontocast.tool.chunk.assignment).
Source code in ontocast/onto/section_models.py
OutlineLabelReport
¶
Bases: BasePydanticModel
What the model tier (CHUNK_SECTION_CLASSIFIER=llm) did for one document.
The tier is best effort: a window whose call fails gives no votes and the
document is still prepared. windows_failed above zero means part of
the outline was labelled without the model.
Source code in ontocast/onto/section_models.py
Attributes¶
errors = Field(default_factory=dict, description='Failed windows by exception class name.')
class-attribute
instance-attribute
¶
windows = Field(default=0, description='Outline windows sent to the model.')
class-attribute
instance-attribute
¶
windows_failed = Field(default=0, description='Windows whose call raised and gave no votes.')
class-attribute
instance-attribute
¶
SectionSpan
¶
Bases: BasePydanticModel
Character span of a document section with a normalised label.
label is None for a region whose section type is not (yet) known —
for example an unrecognised but section-like heading. Such a span is
explicitly unresolved rather than absent, which is what stops a neighbouring
label from being smeared across it.