Skip to main content

UnifiedQueryRequest

Struct UnifiedQueryRequest 

Source
pub struct UnifiedQueryRequest {
    pub rank_by: Value,
    pub top_k: usize,
    pub filter: Option<Value>,
    pub include_metadata: bool,
    pub include_vectors: bool,
    pub distance_metric: DistanceMetric,
}
Expand description

Unified query request with flexible ranking options (Turbopuffer-inspired)

§Example

use dakera_client::UnifiedQueryRequest;

// Vector ANN search
let request = UnifiedQueryRequest::vector_search(vec![0.1, 0.2, 0.3], 10);

// Full-text BM25 search
let request = UnifiedQueryRequest::fulltext_search("content", "hello world", 10);

// Custom rank_by with filters
let request = UnifiedQueryRequest::vector_search(vec![0.1, 0.2, 0.3], 10)
    .with_filter(serde_json::json!({"category": {"$eq": "science"}}));

Fields§

§rank_by: Value

How to rank documents (required)

§top_k: usize

Number of results to return

§filter: Option<Value>

Optional metadata filter

§include_metadata: bool

Include metadata in results

§include_vectors: bool

Include vectors in results

§distance_metric: DistanceMetric

Distance metric for vector search (default: cosine)

Implementations§

Source§

impl UnifiedQueryRequest

Create a new unified query request with vector ANN search

Create a new unified query request with vector kNN search

Create a new unified query request with full-text BM25 search

Source

pub fn attribute_order( field: impl Into<String>, direction: SortDirection, top_k: usize, ) -> Self

Create a new unified query request with attribute ordering

Source

pub fn with_rank_by(rank_by: Value, top_k: usize) -> Self

Create a unified query with a raw rank_by JSON value

Source

pub fn with_filter(self, filter: Value) -> Self

Add a filter to the query

Source

pub fn include_metadata(self, include: bool) -> Self

Set whether to include metadata

Source

pub fn include_vectors(self, include: bool) -> Self

Set whether to include vector values

Source

pub fn with_distance_metric(self, metric: DistanceMetric) -> Self

Set the distance metric

Source

pub fn with_top_k(self, top_k: usize) -> Self

Set the number of results to return

Trait Implementations§

Source§

impl Clone for UnifiedQueryRequest

Source§

fn clone(&self) -> UnifiedQueryRequest

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 UnifiedQueryRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for UnifiedQueryRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for UnifiedQueryRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,