Skip to main content

QueryBuilder

Struct QueryBuilder 

Source
pub struct QueryBuilder<'a> { /* private fields */ }
Expand description

Per-call builder returned by Client::query.

Awaiting the builder retrieves candidate memories via vector search, re-ranks them using the configured RankingStrategy (default: RankingStrategy::default_hybrid), and returns a MemoryContext suitable for dropping into a system prompt.

The default ranking parameters may drift pre-1.0. Callers who need stable behavior across memoir-core versions should pass an explicit RankingStrategy::Hybrid { .. } via Self::ranking.

Kind toggles (episodic/semantic) and metadata/time-range filters match crate::client::SearchBuilder’s shape and semantics.

§Examples

let context = client.query("what did the user say about deployments?", scope).await?;
println!("{context}");

Opt into an explicit strategy:

let context = client
    .query("recent deployments", scope)
    .ranking(RankingStrategy::Hybrid {
        alpha: 0.5,
        decay: DecayFn::Exponential { half_life: chrono::Duration::days(3) },
    })
    .await?;

Implementations§

Source§

impl<'a> QueryBuilder<'a>

Source

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

Caps the number of returned memories. Defaults to DEFAULT_QUERY_LIMIT.

Source

pub fn episodic(self) -> Self

Restricts retrieval to episodic memories. See crate::client::SearchBuilder for kind-toggle semantics.

Source

pub fn semantic(self) -> Self

Restricts retrieval to semantic memories. See crate::client::SearchBuilder for kind-toggle semantics.

Source

pub fn metadata_filter(self, filter: MemoryFilter) -> Self

Applies a caller-supplied metadata filter alongside the scope+kind filter.

Source

pub fn min_similarity(self, threshold: f32) -> Self

Drops candidates whose raw cosine score is below threshold.

Source

pub fn created_after(self, at: impl Into<DateTime<FixedOffset>>) -> Self

Restricts to memories written at or after at (inclusive).

Source

pub fn created_before(self, at: impl Into<DateTime<FixedOffset>>) -> Self

Restricts to memories written strictly before at (exclusive).

Source

pub fn event_at_after(self, at: impl Into<DateTime<FixedOffset>>) -> Self

Restricts to memories whose event_at is at or after at (inclusive).

Source

pub fn event_at_before(self, at: impl Into<DateTime<FixedOffset>>) -> Self

Restricts to memories whose event_at is strictly before at (exclusive).

Source

pub fn ranking(self, strategy: RankingStrategy) -> Self

Selects the ranking strategy. Defaults to RankingStrategy::default_hybrid.

Trait Implementations§

Source§

impl<'a> IntoFuture for QueryBuilder<'a>

Source§

type Output = Result<MemoryContext, ClientError>

The output that the future will produce on completion.
Source§

type IntoFuture = Pin<Box<dyn Future<Output = <QueryBuilder<'a> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for QueryBuilder<'a>

§

impl<'a> !UnwindSafe for QueryBuilder<'a>

§

impl<'a> Freeze for QueryBuilder<'a>

§

impl<'a> Send for QueryBuilder<'a>

§

impl<'a> Sync for QueryBuilder<'a>

§

impl<'a> Unpin for QueryBuilder<'a>

§

impl<'a> UnsafeUnpin for QueryBuilder<'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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more