Crate hyphae_retrieval 

Exact retrieval and provider-neutral abstention semantics.

The reference engine accepts vectors directly. No embedding or model provider is enabled by default.

Structs

Abstention

Evidence for a normal abstention outcome.

DurableVectorRecord

One durable exact-retrieval candidate.

ExactAbstention

Stable durable exact-retrieval abstention evidence.

ExactRetrievalLimits

Runtime and shape limits for durable exact retrieval.

ExactRetrievalMatch

One canonical exact match.

ExactRetrievalRequest

Durable exact-retrieval request under semantics v2.

HybridAbstention

Both branches abstained.

HybridExplanation

Full per-result fusion explanation.

HybridMatch

One canonical fused match.

HybridRequest

Complete fusion request.

LexicalAbstention

Stable normal abstention evidence.

LexicalField

One configured document field.

LexicalFieldContribution

One field contribution for one query term.

LexicalIndexDefinition

Immutable named lexical-index definition.

LexicalLimits

Complete bounded execution policy.

LexicalMatch

One canonical lexical match.

LexicalMaterializedCorpus

Complete bounded view read from a rebuildable lexical projection.

LexicalMaterializedDocument

Rebuildable lexical statistics for one document that contains at least one normalized query term.

LexicalRequest

Complete lexical retrieval request.

LexicalTermContribution

One canonical query-term explanation.

RetrievalLimits

Runtime and shape limits for exact global retrieval.

RetrievalMatch

One globally ranked exact match.

RetrievalRequest

Exact cosine search and abstention policy.

RetrievalSystemClock

Production retrieval clock backed by Instant.

VectorRecord

One candidate vector with a globally unique binary key.

Enums

AbstentionReason

Stable reason why semantic retrieval declined to return matches.

ExactAbstentionReason

Stable reason why durable exact retrieval declined matches.

ExactRetrievalError

Failure to execute durable exact retrieval completely.

ExactRetrievalOutcome

Complete durable exact-retrieval outcome.

HybridBranchAbsence

Preserved reason for an absent branch.

HybridError

Fusion failure.

HybridOutcome

Complete hybrid outcome.

LexicalAbstentionReason

Stable normal abstention reason.

LexicalError

Complete lexical execution failure.

LexicalOutcome

Complete lexical outcome.

RetrievalError

Failure to validate or completely execute exact semantic retrieval.

RetrievalOutcome

Complete exact retrieval outcome.

Constants

HYBRID_RRF_CONSTANT

Fixed RRF rank constant.

MAX_LEXICAL_FIELDS

Maximum fields in one lexical definition.

MAX_LEXICAL_FIELD_WEIGHT_MICROS

Maximum positive field weight.

MAX_LEXICAL_PATH_SEGMENTS

Maximum exact segments in one configured path.

MAX_LEXICAL_PATH_SEGMENT_BYTES

Maximum UTF-8 bytes in one path segment.

MAX_LEXICAL_TOKEN_BYTES

Maximum UTF-8 token length retained by tokenizer v1.

Traits

ExactRetrievalClock

Monotonic clock used by the canonical executor.

RetrievalClock

Injectable monotonic clock for deterministic timeout conformance.

Functions

cosine_score_nanos

Computes the canonical integer cosine score from ADR-0015.

fuse_hybrid

Fuses complete branch outcomes with deterministic RRF.

retrieve

Executes exact global cosine retrieval with the system clock.

retrieve_exact

Executes durable exact retrieval using the process monotonic clock.

retrieve_exact_with_clock

Executes durable exact retrieval using a caller-supplied monotonic clock.

retrieve_lexical

Executes the deterministic BM25F-compatible reference algorithm.

retrieve_lexical_materialized

Executes BM25F from a rebuildable materialized lexical projection.

retrieve_with_clock

Executes exact retrieval with an injectable monotonic clock.

tokenize_v1

Applies tokenizer semantics hyphae-unicode-tokenizer-v1.

tokenize_v1_checked

Applies tokenizer v1 while cooperatively checking work and retained-token policy.