Skip to content

Models

The dataclasses that cross every boundary: the record envelope, the caller's identity, and the search contract.

retold.models

Framework-neutral types shared by storage, ingestion, retrieval, and adapters.

LexicalTerm dataclass

One query term that matched an indexed record.

LexicalMatch dataclass

The terms matched for the single query that gave a record its strongest lexical coverage.

fraction property

fraction: float

Return the matched share of the query terms used for this lexical hit.

validate_private_scope_component

validate_private_scope_component(
    value: str, name: str
) -> None

Reject a private-scope component that would make the encoded pair ambiguous.