Struct RecallQuery 

pub struct RecallQuery<'a> {
    pub now: u64,
    pub text: Option<&'a str>,
    pub vector: Option<&'a [f32]>,
    pub tags: &'a [&'a str],
    pub entities: &'a [&'a str],
    pub as_of: Option<u64>,
    pub range: Option<(u64, u64)>,
    pub k: usize,
    pub token_budget: Option<usize>,
    pub include_closed: bool,
    pub ef: Option<usize>,
    pub graph_depth: Option<u32>,
}

A recall request. Default-like construction via RecallQuery::text plus field overrides.

Fields

now: u64

Host timestamp, unix milliseconds.

text: Option<&'a str>

Free-text query for the lexical source.

vector: Option<&'a [f32]>

Query embedding for the vector source (len == Config::dim).

tags: &'a [&'a str]

Tag filter: a fact must carry all of these.

entities: &'a [&'a str]

Entity anchors for the graph source.

as_of: Option<u64>

Validity instant; defaults to now.

range: Option<(u64, u64)>

recorded_at window [from, to) for the temporal source.

k: usize

Result cap; 0 means the default 8, hard ceiling 64.

token_budget: Option<usize>

Token budget of the rendered block; defaults to 512.

include_closed: bool

Show closed revisions too (whole chains, marked by intervals).

ef: Option<usize>

HNSW beam-width override for the vector source; defaults to Config::hnsw_ef_search. Ignored while the engine is in the flat regime (below Config::flat_to_hnsw).

graph_depth: Option<u32>

Graph expansion depth for this query; defaults to Config::graph_depth, and is not capped: the cost of a walk is held by the entity and edge caps, not by the hop count.

A per-call knob for the same reason k and token_budget are: how wide a net to cast is a property of the question, not of the memory. “What is known around this person” wants more hops than “what is this person’s stated preference”, and one number for the whole database cannot be both.

Some(0) asks for no expansion at all: the anchors’ own facts, and no neighbours.

Implementations

impl<'a> RecallQuery<'a>

pub fn text(now: u64, text: &'a str) -> RecallQuery<'a>

A plain text query with every other knob at its default.

Trait Implementations

impl<'a> Clone for RecallQuery<'a>

fn clone(&self) -> RecallQuery<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RecallQuery<'a>

impl<'a> Debug for RecallQuery<'a>

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

Formats the value using the given formatter.