Struct RecallRequest 

pub struct RecallRequest {

    pub query: String,
    pub agent_id: Option<String>,
    pub limit: Option<usize>,
    pub memory_type: Option<MemoryType>,
    pub memory_types: Option<Vec<MemoryType>>,
    pub scope: Option<Scope>,
    pub min_importance: Option<f32>,
    pub tags: Option<Vec<String>>,
    pub org_id: Option<String>,
    pub strategy: Option<String>,
    pub temporal_range: Option<TemporalRange>,
    pub recency_half_life_hours: Option<f64>,
    pub hybrid_weights: Option<Vec<f32>>,
    pub rrf_k: Option<f32>,
    pub as_of: Option<String>,
    pub explain: Option<bool>,
    pub with_provenance: Option<bool>,
    pub mode: Option<RetrievalMode>,
    pub current_fact_resolver: Option<CurrentFactResolverConfig>,
    pub orientation_cache: Option<OrientationCacheConfig>,
    pub evidence_budget: Option<EvidenceBudget>,
    pub retained_token_budget: Option<usize>,
    pub domain_scope: Option<DomainScope>,
}

Fields

query: String

agent_id: Option<String>

limit: Option<usize>

memory_type: Option<MemoryType>

memory_types: Option<Vec<MemoryType>>

scope: Option<Scope>

min_importance: Option<f32>

tags: Option<Vec<String>>

org_id: Option<String>

strategy: Option<String>

temporal_range: Option<TemporalRange>

recency_half_life_hours: Option<f64>

hybrid_weights: Option<Vec<f32>>

rrf_k: Option<f32>

as_of: Option<String>

explain: Option<bool>

When set, each ScoredMemory is augmented with a score_breakdown that reports the per-signal score contributions (vector, bm25, graph, recency) and final RRF rank.

with_provenance: Option<bool>

v0.4.0-rc3 (Task B1) — when Some(true) AND the engine has a ProvenanceSigner attached, the response carries a ReadProvenance HMAC receipt over the recalled records. Default None keeps the recall hot-path overhead at zero for callers that don’t need verifiable receipts.

mode: Option<RetrievalMode>

v0.4.4 — typed retrieval mode. When Some, takes precedence over the legacy strategy field (which stays in place for backwards compatibility). When None, the engine falls back to parsing strategy exactly as in v0.4.3. See crate::retrieval::RetrievalMode.

current_fact_resolver: Option<CurrentFactResolverConfig>

v0.4.7 — opt-in current-fact resolver. When Some, the engine runs a post-processor over the standard recall result set that groups candidates by cfg.fact_key and keeps the most-recent write per group. See crate::query::current_fact_resolver for the contract + the MINTEval arXiv:2605.18565 anchor. Default None keeps the read path unchanged.

orientation_cache: Option<OrientationCacheConfig>

v0.4.8 — opt-in orientation cache. When Some AND the engine has an OrientationCacheStore attached, the engine maintains a per-namespace, constant-token “context map” updated from each recall hit, and returns a bounded rendering in RecallResponse::orientation_cache. PEEK-anchored (arXiv:2605.19932). Default None keeps the read path unchanged.

evidence_budget: Option<EvidenceBudget>

v0.4.12 — opt-in cost-aware evidence budget. When Some, the engine runs the crate::query::evidence selector over the ranked candidate set and returns the smallest prefix that clears the configured sufficiency bar (capped by max_evidence). Purely subtractive — it never reorders the retrieval’s top-k. Default None keeps the read path unchanged (front-loaded top-limit).

retained_token_budget: Option<usize>

EMBER (arXiv:2606.05894) — opt-in budgeted evidence retention. When Some(budget), the engine builds a RetentionReport that packs the recalled hits into at most budget retained tokens as verbatim evidence capsules (excerpt + retrieval key), ranked by a recency × hit-rate recoverability heuristic, and returns it in RecallResponse::retained_evidence. Purely additive — the memories list is unchanged, so the default read path is unaffected. See crate::query::retained.

domain_scope: Option<DomainScope>

v0.4.15 — domain-scoped recall predicate (MASDR-RAG, arXiv:2606.11350). When set (or when mode is RetrievalMode::DomainScoped), the candidate set is restricted to the metadata-defined sub-corpus described by this DomainScope before the dense similarity step, countering vector-search dilution at scale. Default None keeps the read path unchanged.

Implementations

impl RecallRequest

pub fn new(query: String) -> Self

Trait Implementations

impl Clone for RecallRequest

fn clone(&self) -> RecallRequest

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.

impl<'de> Deserialize<'de> for RecallRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RecallRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.