Struct RecallQuery 

pub struct RecallQuery {

    pub context: Option<String>,
    pub query: Option<String>,
    pub q: Option<String>,
    pub namespace: Option<String>,
    pub limit: Option<usize>,
    pub tags: Option<String>,
    pub since: Option<String>,
    pub until: Option<String>,
    pub as_agent: Option<String>,
    pub budget_tokens: Option<usize>,
    pub context_tokens: Option<String>,
    pub session_default: Option<bool>,
    pub has_citations: Option<bool>,
    pub source_uri_prefix: Option<String>,
    pub kinds: Option<String>,
    pub session_id: Option<String>,
    pub include_archived: Option<bool>,
    pub confidence_tier: Option<String>,
    pub verbose_provenance: Option<bool>,
    pub format: Option<String>,
}

Fields

context: Option<String>

query: Option<String>

query alias for context — the cert harness (S79) uses ?query=…. Both forms route to the same code path; context wins when both are supplied.

q: Option<String>

q alias for context/query — matches the search-style API surface (/api/v1/memories?q=…) so callers can use the same query token field across both endpoints.

namespace: Option<String>

limit: Option<usize>

tags: Option<String>

since: Option<String>

until: Option<String>

as_agent: Option<String>

Task 1.5 visibility filtering.

budget_tokens: Option<usize>

Task 1.11 — context-budget-aware recall. When set, return the top-scored memories whose cumulative estimated tokens fit within this budget.

context_tokens: Option<String>

#1622 — salience tokens biasing the recall query embedding, comma-separated (context_tokens=alpha,beta), mirroring the kinds CSV convention for GET query params.

session_default: Option<bool>

v0.7.0 (issue #518) — when true, splice defaults from [agents.defaults.recall_scope] in config.toml for any filter field not explicitly set on this request. Resolution: explicit args > recall_scope defaults > compiled defaults. Default false preserves v0.6.x recall semantics exactly.

has_citations: Option<bool>

v0.7.0 Form 4 (issue #757) — restrict to memories whose citations array is non-empty. Composes with the other filters; default None preserves v0.7.0 recall semantics.

source_uri_prefix: Option<String>

v0.7.0 Form 4 (issue #757) — restrict to memories whose source_uri column begins with this exact prefix.

kinds: Option<String>

v0.7.x Form 6 (issue #759) — Batman-taxonomy memory-kind filter. Comma-separated string (kinds=concept,claim). OR-of-kinds within the param; AND with namespace / tags / time-window / visibility. None (default) preserves the pre-Form-6 “no kind filter” semantics. Unknown tokens are silently dropped (forward-compat with future variants).

session_id: Option<String>

v0.7.0 (issue #518) — per-session “recently accessed” boost. When set and non-empty, the rerank post-step adds +0.05 to any recall candidate already in this session’s ring buffer (cap 50 ids, FIFO eviction); the recall hit set is appended to the ring so subsequent recalls in the same session reuse the new context. None/empty preserves pre-#518 recall semantics exactly.

include_archived: Option<bool>

v0.7.0 #1098 — WT-1-E include atomised sources alongside atoms. HTTP parity with the MCP RecallRequest. Pre-#1098 this field was hard-coded to None in RecallRequest::from_http_query.

confidence_tier: Option<String>

v0.7.0 #1098 — Gap 4 (#887) confidence-tier filter. HTTP parity with the MCP RecallRequest.

verbose_provenance: Option<bool>

v0.7.0 #1098 — Gap 7 (#890) per-row provenance decoration. HTTP parity with the MCP RecallRequest.

format: Option<String>

v0.7.0 #1098 — response format selector (e.g. toon_compact). HTTP parity with the MCP RecallRequest.

Implementations

impl RecallQuery

pub fn resolved_kinds(&self) -> Option<Vec<MemoryKind>>

v0.7.x Form 6 — parse the optional kinds query string. Comma-separated. "all" (case-insensitive) is treated as “no filter” (returns None). Drops unknown tokens silently.

Trait Implementations

impl Debug for RecallQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecallQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.