Skip to main content

Module retrieval

Module retrieval 

Source
Expand description

Retrieval operations: local embedding generation and hybrid search with RRF fusion.

Structs§

DocumentEmbeddingOutcome
Outcome for one document embedding. The exact-input fingerprint is present only when the resolved provider has the runtime-audited preparation path.
EmbeddingTruncationReport
Aggregate truncation accounting for one logical write or reindex batch.
HybridSearchOutcome
Result of a hybrid search: the fused hits — text hits alone when the vector arm failed — plus the vector arm’s error, if any.
SearchHit
A unified search result combining vector and text signals.
SearchSignals
Retained component scores before fusion and strategy-local modifiers. An absent retrieval leg has no score, which is distinct from a measured zero. Scores belong to the backend and model that produced the retained hit; vector similarities from different embedding models are not comparable.

Enums§

RankScoreKind
The strategy that produced a hit’s ordering score, including local modifiers.
SearchSource
Which retrieval path(s) contributed to a hit.

Constants§

EMBEDDING_INPUT_TRUNCATED_WARNING
Advisory emitted by write verbs when only the embedding input was bounded.

Functions§

bounded_embedding_input
Return the longest UTF-8-safe prefix of text within max_bytes and whether it was shortened.
document_embedding_budget
Maximum document bytes accepted before the embedding service adds its model prefix.