Struct RecallRequest 

pub struct RecallRequest {
    pub query: Vec<f32>,
    pub top_k: usize,
    pub memory_types: Option<Vec<MemoryType>>,
    pub agent_id: Option<String>,
    pub metric: Metric,
    pub weights: ScoreWeights,
    pub n_probe: Option<usize>,
    pub n_rerank: Option<usize>,
    pub track_access: bool,
    pub filter: Filter,
    pub max_bytes: Option<usize>,
}

A retrieval request for Mnemo::recall.

Fields

query: Vec<f32>

Query embedding.

top_k: usize

Maximum results to return.

memory_types: Option<Vec<MemoryType>>

Restrict to these memory types (None = all types).

agent_id: Option<String>

Restrict to a single agent’s view: its own memories plus shared ones.

metric: Metric

Similarity metric.

weights: ScoreWeights

Multi-signal score weights.

n_probe: Option<usize>

Index override: partitions to probe (None = index default). Ignored when no ANN index is present.

n_rerank: Option<usize>

Index override: candidates to rerank (None = index default). Ignored when no ANN index is present.

track_access: bool

Whether to update each result’s accessed_at and access_count in the catalog. Defaults to true, matching pre-v5 behavior.

Set to false for fully read-only recall — useful for batch scoring, dry-run scoring, or recalls run by introspection tooling (e.g. mnemo about consumers) where you don’t want the score’s own observation to perturb the database. With false, recall does not dirty the catalog and the next flush is a no-op.

filter: Filter

Phase 12.6 pre-scoring filter: session_id + AND-ed metadata conditions applied before the candidate is scored. Default is Filter::default (no constraints). When the ANN index is on and this filter is selective enough to starve the shortlist below top_k, Phase 12.1’s widen-then-exact-scan logic kicks in so the result still carries up to top_k correct hits.

max_bytes: Option<usize>

Phase 12.8 post-scoring budget: stop adding hits once the UTF-8 bytes of their content fields (not the serialized record body) would exceed this many bytes. None (default) means no budget and every hit through top_k is returned. If the top-1 hit is already over budget it is still returned — callers that need an absolute cap should also pre-size top_k.

Counts only the UTF-8 content bytes so the number is stable across the Rust / Python / CLI / MCP surfaces; the JSON or MessagePack envelope is excluded. Roughly 4 bytes per BPE token for English text — a 4 KB budget comfortably holds ~1K tokens.

Observable through RecallResponse::truncated (Mnemo::recall_budgeted): true iff at least one scored hit was dropped by this budget, false otherwise.

Implementations

impl RecallRequest

pub fn new(query: Vec<f32>) -> Self

A request with sensible defaults for a query embedding.

pub fn filter(self, filter: Filter) -> Self

Phase 12.6: attach a pre-scoring filter. See Filter and [FilterTerm] for term shapes.

pub fn max_bytes(self, n: usize) -> Self

Phase 12.8: cap the total UTF-8 bytes of returned content fields. See RecallRequest::max_bytes.

pub fn from_text(embedder: &dyn Embedder, query_text: &str) -> Result<Self>

Build a request by embedding query_text with the supplied embedder (Phase 3). Shorthand for embedder.embed(&[text]) + RecallRequest::new; same defaults as new. Fails if the embedder returns an empty vector list or an embedding failure.

pub fn top_k(self, k: usize) -> Self

Set the result cap.

pub fn types(self, t: Vec<MemoryType>) -> Self

Restrict to specific memory types.

pub fn agent(self, agent_id: impl Into<String>) -> Self

Restrict to one agent’s view.

pub fn metric(self, metric: Metric) -> Self

Set the similarity metric (default: cosine).

pub fn weights(self, weights: ScoreWeights) -> Self

Replace the multi-signal score weights.

pub fn n_probe(self, n: usize) -> Self

Override the number of IVF partitions probed (accuracy/speed dial).

pub fn n_rerank(self, n: usize) -> Self

Override the number of candidates reranked exactly (accuracy dial).

pub fn track_access(self, track: bool) -> Self

Toggle whether recall updates accessed_at / access_count on the returned memories’ catalog entries (default true). Pass false for a fully read-only recall — see the field doc.

Trait Implementations

impl Clone for RecallRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecallRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.