all2md.search.types

Shared data structures for the search subsystem.

class all2md.search.types.SearchMode

Bases: Enum

Enumerate the supported search strategies.

GREP = 1

KEYWORD = 2

VECTOR = 3

HYBRID = 4

class all2md.search.types.Chunk

Bases: object

Represents an indexed text chunk with associated metadata.

chunk_id: str

text: str

metadata: Mapping[str, Any]

document_path() → Path | None

Return Path to the originating document when available.

__init__(chunk_id: str, text: str, metadata: Mapping[str, ~typing.Any]=<factory>) → None

class all2md.search.types.SearchResult

Bases: object

Search result referencing a chunk and its relevance score.

chunk: Chunk

score: float

metadata: Mapping[str, Any]

__init__(chunk: Chunk, score: float, metadata: Mapping[str, ~typing.Any]=<factory>) → None

class all2md.search.types.SearchQuery

Bases: object

Normalized query inputs for index backends.

raw_text: str

filters: Mapping[str, Any]

to_dict() → MutableMapping[str, Any]

Return a mutable copy suitable for JSON serialization.

__init__(raw_text: str, filters: Mapping[str, ~typing.Any]=<factory>) → None