Skip to main content

Module documents

Module documents 

Source

Structs§

BatchTooLarge
A document batch over one of the engine’s batch limits (items, chunks, source or metadata bytes, embedding values, transaction bytes). Nothing was written; a smaller batch can succeed.
DocumentChunk
DocumentInput
DocumentRecord
A stored document as the store holds it: first chunk’s text, metadata and version.
DocumentResult
GraphUnavailable
A graph query reached a store without a graph index.
IngestOptions
Options of one memorize_documents_with call; the default is exactly memorize_documents.
MemoryDocumentStore
MemoryStoreStats
Counts describing a MemoryDocumentStore.
SearchOptions
VectorIndexStatus
State of the snapshot relative to the live store.
VectorQueryOptions
Per-query options of crate::HmsCore::search_vectors.

Enums§

EncodeMode
When a document’s chunk hypervectors are computed. Terms, postings and text are stored at ingest in every mode, so lexical search sees the document at once; only the vector side (HmsCore::query over chunk vectors) differs.
VectorIndexKind
Which implementation answered, or may answer, a vector query.
VectorIndexMode
Route of one vector query.

Constants§

DEFAULT_EF
Default beam width of a graph query. The accepted qgraph rows reached recall 0.95 at ef 736 on glove-100-angular (1.18M vectors, benchmarks/results/ann_modal_confirm_v1.json); stores of up to a few hundred thousand embedding rows reach it with a far smaller beam, and tests/server_ann.rs holds the default to recall >= 0.95 on its corpus.
DEFAULT_GRAPH_MIN_ROWS
Default graph_min_rows: a snapshot with fewer rows carries only the exact scan, which beats a graph traversal at that size.
MAX_BATCH_ITEMS
Documents, and chunks, one memorize_documents_with call accepts.
MAX_EF
MAX_K
REBUILD_AFTER_MUTATIONS
Mutations since the capture after which maintenance builds a fresh snapshot.
SNAPSHOT_MIN_ROWS
Fewest embedded chunks worth a snapshot; smaller stores take the generic exact path.

Traits§

VectorIndex
A nearest-neighbour index over the rows of one VectorSnapshot.

Functions§

chunk_document