Models and errors¶

Manifest models¶

.. py:class:: DocumentManifest(document_id: ‘str’, chunks: ‘tuple[ChunkRecord, …]’ = (), metadata: ‘Mapping[str, Any]’ = , chunker_id: ‘str’ = ‘’, chunker_params_hash: ‘str’ = ‘’, normalizer_version: ‘str’ = ‘’, schema_version: ‘int’ = 1)

module:

steadlith.content.manifest

.. py:class:: CorpusManifest(documents: ‘Mapping[str, DocumentManifest]’ = , metadata: ‘Mapping[str, Any]’ = , schema_version: ‘int’ = 1)

module:

steadlith.content.manifest

.. py:class:: ChunkRecord(chunk_hash, start_offset, end_offset, token_count, metadata=)

module:

steadlith.models

The compact per-chunk record stored in a document manifest.

Index result models¶

.. py:class:: VectorMatch(score: ‘float’, chunk_hash: ‘str’, text: ‘str’, document_id: ‘str’, start_offset: ‘int’, end_offset: ‘int’, metadata: ‘Mapping[str, Any]’)

module:

steadlith.index.adapters.base

.. py:class:: IndexStatus(corpus_root: ‘str | None’, generation: ‘int’, documents: ‘int’, active_chunks: ‘int’, tombstoned_chunks: ‘int’, hard_cuts: ‘int’, total_boundaries: ‘int’, model_id: ‘str | None’, params_hash: ‘str | None’)

module:

steadlith.index.adapters.base

Error hierarchy¶

.. py:class:: SteadlithError

module:

steadlith.errors

Base class for expected, user-facing Steadlith failures.

.. py:class:: ConfigError

module:

steadlith.errors

Raised when configuration is absent, malformed, or inconsistent.

.. py:class:: BackendError

module:

steadlith.errors

Raised when an index or cache backend cannot complete an operation.

.. py:class:: ProviderError

module:

steadlith.errors

Raised when an embedding provider cannot complete an operation.

.. py:class:: TransientProviderError

module:

steadlith.errors

A provider failure that is explicitly safe to retry with backoff.

.. py:class:: VerificationError

module:

steadlith.errors

Raised when durable manifest and active index state disagree.

.. py:class:: ExitCode(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)

module:

steadlith.errors

Stable process exit codes used by the steadlith command.