Skip to main content

RetrievalQuery

Struct RetrievalQuery 

Source
pub struct RetrievalQuery {
    pub text: String,
    pub architecture: Option<ArchitectureFingerprint>,
    pub now: DateTime<Utc>,
    pub half_life_days: f64,
    pub embedding: Option<(String, Vec<f32>)>,
    pub limit: usize,
    pub research_line: Option<String>,
    pub tags: Vec<String>,
}
Expand description

What to retrieve, and what to measure it against.

Fields§

§text: String

Free text. Empty is allowed: the other three terms still rank.

§architecture: Option<ArchitectureFingerprint>

Architecture to compare against, when the caller has one.

§now: DateTime<Utc>

Reference time for recency. A parameter, not Utc::now(), so ranking is reproducible.

§half_life_days: f64

Recency half-life in days; DEFAULT_HALF_LIFE_DAYS unless set.

§embedding: Option<(String, Vec<f32>)>

Query vector, from the same embedder that produced the records’. When present, it blends into the lexical term for records carrying a vector from the same model.

§limit: usize

Maximum number of results returned.

§research_line: Option<String>

Restrict to one research line.

§tags: Vec<String>

Every listed tag must be present.

Implementations§

Source§

impl RetrievalQuery

Source

pub fn new(text: impl Into<String>, now: DateTime<Utc>) -> Self

A text query against now, with the default half-life.

Source

pub fn with_architecture(self, architecture: ArchitectureFingerprint) -> Self

Compare candidates structurally against this fingerprint, activating the structural term.

Source

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

Cap the number of results.

Source

pub fn in_line(self, line: impl Into<String>) -> Self

Restrict candidates to one research line, before scoring.

Source

pub fn with_tags(self, tags: Vec<String>) -> Self

Require every listed tag on a candidate, before scoring.

Trait Implementations§

Source§

impl Clone for RetrievalQuery

Source§

fn clone(&self) -> RetrievalQuery

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 Debug for RetrievalQuery

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

The receiver as &dyn Any, ready for downcast_ref.
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.

§

impl<T> Instrument for T

§

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

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

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> Same for T

Source§

type Output = T

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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