Skip to main content

RecallQuery

Struct RecallQuery 

Source
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>,
}
Expand description

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).

Implementations§

Source§

impl<'a> RecallQuery<'a>

Source

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

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

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for RecallQuery<'a>

§

impl<'a> RefUnwindSafe for RecallQuery<'a>

§

impl<'a> Send for RecallQuery<'a>

§

impl<'a> Sync for RecallQuery<'a>

§

impl<'a> Unpin for RecallQuery<'a>

§

impl<'a> UnsafeUnpin for RecallQuery<'a>

§

impl<'a> UnwindSafe for RecallQuery<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.