SearchQuery

Struct SearchQuery 

Source
pub struct SearchQuery {
    pub query: QueryType,
    pub limit: usize,
    pub min_score: f32,
    pub filters: HashMap<String, Value>,
    pub config: SearchConfig,
}
Expand description

A search query with comprehensive configuration options

Encapsulates all parameters for a search operation including the query itself, result limits, filtering criteria, and algorithm configuration. Supports both text queries (that will be embedded) and pre-computed embedding queries.

§Example

use rrag::prelude::*;

// Simple text query
let query = SearchQuery::new("machine learning algorithms")
    .with_limit(10)
    .with_min_score(0.7);

// Advanced query with filters
let advanced_query = SearchQuery::new("neural networks")
    .with_limit(20)
    .with_min_score(0.6)
    .with_filter("category", "research".into())
    .with_filter("year", 2023.into())
    .with_config(SearchConfig {
        algorithm: SearchAlgorithm::CosineSimilarity,
        enable_reranking: true,
        include_embeddings: true,
        ..Default::default()
    });

// Query with pre-computed embedding
let embedding_query = SearchQuery::from_embedding(embedding)
    .with_limit(5);

§Filter Types

Filters support various data types:

  • Strings: Exact match or pattern matching
  • Numbers: Range queries and exact values
  • Dates: Date range filtering
  • Arrays: “Contains” operations
  • Booleans: Exact boolean matching

Fields§

§query: QueryType

Query text or embedding

§limit: usize

Maximum number of results to return

§min_score: f32

Minimum similarity threshold

§filters: HashMap<String, Value>

Metadata filters

§config: SearchConfig

Search configuration

Implementations§

Source§

impl SearchQuery

Source

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

Create a text-based search query

Source

pub fn embedding(embedding: Embedding) -> Self

Create an embedding-based search query

Source

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

Set result limit

Source

pub fn with_min_score(self, min_score: f32) -> Self

Set minimum score threshold

Source

pub fn with_filter(self, key: impl Into<String>, value: Value) -> Self

Add metadata filter

Source

pub fn with_config(self, config: SearchConfig) -> Self

Set search configuration

Trait Implementations§

Source§

impl Clone for SearchQuery

Source§

fn clone(&self) -> SearchQuery

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchQuery

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
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> 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> 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.
Source§

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

Source§

fn vzip(self) -> V

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> ErasedDestructor for T
where T: 'static,