Struct Query 

pub struct Query {
    pub text: String,
    pub entities: Vec<String>,
    pub kinds: Vec<MemoryKind>,
    pub boost_only: Vec<String>,
    pub limit: usize,
}

What a search is looking for.

Fields

text: String

Raw query text; tokenized on execution.

entities: Vec<String>

Entity surface forms that should receive an exact-match boost.

kinds: Vec<MemoryKind>

Restrict to these kinds; empty means any.

boost_only: Vec<String>

Terms that may rank a hit but never admit one.

A memory lookup is nearly always phrased about its owner — “what’s my usual coffee”, or, when a model writes the query, “the user’s usual coffee”. Those words are the corpus’s own subject form and its aliases, so they have a posting in almost every record. Treated as ordinary terms they cost two things at once: precision, because a question the corpus cannot answer still matches everything and comes back with five arbitrary facts; and time, because every query then walks the whole corpus and sorts it. Measured, that was a recall going from 1 ms at 250 records to 118 ms at 16,000 — superlinear, and eight times past the engine’s own 15 ms lexical deadline.

Listing them here keeps what they are good for and drops what they are not. They still contribute their score to a record some topical term already matched, which is what lets “what coating do I have” prefer the owner’s record over forty belonging to other people. They no longer put a record into the running on their own.

limit: usize

Maximum hits to return.

Implementations

impl Query

pub fn new(text: impl Into<String>) -> Self

A plain text query.

pub fn with_entities<I, S>(self, entities: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Boost documents whose subject or entities match these surface forms.

pub fn with_kinds(self, kinds: Vec<MemoryKind>) -> Self

Restrict the search to certain memory kinds.

pub fn with_boost_only<I, S>(self, terms: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Mark terms that may rank a hit but never admit one.

pub fn with_limit(self, limit: usize) -> Self

Cap the result count.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

Returns the “default value” for a type.