Types

The models check and describe return.

Checking

denckring.core.protocol.Report

Bases: BaseModel

The result of checking a text. satisfied is always score == 1.0, enforced below rather than left as a constructor convention (P2-02).

evidence class-attribute instance-attribute

evidence: list[Evidence] = Field(default_factory=list)

metrics class-attribute instance-attribute

metrics: dict[str, float] = Field(default_factory=dict)

model_config class-attribute instance-attribute

model_config = ConfigDict(validate_assignment=True)

procedure instance-attribute

procedure: str

provenance class-attribute instance-attribute

provenance: Provenance | None = None

satisfied instance-attribute

satisfied: bool

score class-attribute instance-attribute

score: float = Field(ge=0.0, le=1.0)

violations class-attribute instance-attribute

violations: list[Violation] = Field(default_factory=list)

denckring.core.protocol.Violation

Bases: BaseModel

One place where a text fails a procedure.

expected instance-attribute

expected: str

found instance-attribute

found: str

note class-attribute instance-attribute

note: str | None = None

offset class-attribute instance-attribute

offset: int | None = None

rule instance-attribute

rule: str

denckring.core.protocol.Meta

Bases: BaseModel

A catalogue entry. The single source of truth for a procedure's description.

Frozen, with its list-shaped fields as tuples: catalogue.get() returns the same cached object to every caller (P2-01), so a mutable Meta let one caller's introspection silently change what a registered procedure requires for every future check() call. names, definitions and prompt_hints stay plain dicts — no demonstrated mutation path reached them, and freezing a dict field needs a different mechanism than a tuple swap; that residual is deliberate, not overlooked.

aliases class-attribute instance-attribute

aliases: tuple[str, ...] = Field(default_factory=tuple)

apply_requires class-attribute instance-attribute

apply_requires: tuple[str, ...] = Field(
    default_factory=tuple
)

attested class-attribute instance-attribute

attested: Attestation = 'codified'

attribution instance-attribute

attribution: Attribution

checkability instance-attribute

checkability: Checkability

definitions instance-attribute

definitions: dict[Lang, str]

deterministic class-attribute instance-attribute

deterministic: bool = True

family instance-attribute

family: Family

id instance-attribute

id: str

kind instance-attribute

kind: Kind

languages instance-attribute

languages: tuple[Lang, ...]

layer class-attribute instance-attribute

layer: Layer = 'verfahren'

model_config class-attribute instance-attribute

model_config = ConfigDict(frozen=True)

names instance-attribute

names: dict[Lang, str]

notes class-attribute instance-attribute

notes: str | None = None

prompt_hints class-attribute instance-attribute

prompt_hints: dict[Lang, str] = Field(default_factory=dict)

requires class-attribute instance-attribute

requires: tuple[str, ...] = Field(default_factory=tuple)

source instance-attribute

source: str

Describing

denckring.core.describe.Description

Bases: BaseModel

Everything a model needs to use one procedure.

apply_missing instance-attribute

apply_missing: list[str]

apply_params instance-attribute

apply_params: dict[str, Any]

apply_requires instance-attribute

apply_requires: list[str]

checkability instance-attribute

checkability: str

constructive instance-attribute

constructive: bool

definition instance-attribute

definition: str

family instance-attribute

family: str

id instance-attribute

id: str

kind instance-attribute

kind: str

languages instance-attribute

languages: list[str]

missing instance-attribute

missing: list[str]

name instance-attribute

name: str

params instance-attribute

params: dict[str, Any]

prompt_hints instance-attribute

prompt_hints: str | None

reading instance-attribute

reading: Reading

requires instance-attribute

requires: list[str]

runnable instance-attribute

runnable: bool

runs_in instance-attribute

runs_in: list[str]

scholarly class-attribute instance-attribute

scholarly: Scholarly | None = None

untranslated instance-attribute

untranslated: list[str]

denckring.core.describe.Summary

Bases: BaseModel

One catalogue row, compact enough to list eighty of.

constructive instance-attribute

constructive: bool

definition instance-attribute

definition: str

family instance-attribute

family: str

id instance-attribute

id: str

kind instance-attribute

kind: str

name instance-attribute

name: str

runnable instance-attribute

runnable: bool

denckring.core.describe.Scholarly

Bases: BaseModel

Where a procedure comes from. Returned only when asked for.

aliases instance-attribute

aliases: list[str]

attested instance-attribute

attested: str

attribution instance-attribute

attribution: str

notes instance-attribute

notes: str | None

source instance-attribute

source: str