Skip to main content

VectorSearchRequestBuilder

rig::vector_store::request

Struct VectorSearchRequestBuilder 

Source 
pub struct VectorSearchRequestBuilder<F = Filter<Value>, Q = Missing, S = Missing> { /* private fields */ }
Expand description

Builder for VectorSearchRequest. Requires query and samples.

Implementations§

Source§

impl<F, Q, S> VectorSearchRequestBuilder<F, Q, S>
where F: SearchFilter,

Source

pub fn query<T>( self, query: T, ) -> VectorSearchRequestBuilder<F, Provided<String>, S>
where T: Into<String>,

Sets the query text. Required.

Source

pub fn samples( self, samples: u64, ) -> VectorSearchRequestBuilder<F, Q, Provided<u64>>

Sets the maximum number of results. Required.

Source

pub fn threshold(self, threshold: f64) -> Self

Sets the minimum similarity threshold.

Source

pub fn additional_params(self, params: Value) -> Result<Self, VectorStoreError>

Sets backend-specific parameters.

Source

pub fn filter(self, filter: F) -> Self

Sets a filter expression.

Source§

impl<F> VectorSearchRequestBuilder<F, Provided<String>, Provided<u64>>

Only implement build() when both query and samples have been provided.

Source

pub fn build(self) -> VectorSearchRequest<F>

Builds the request

Trait Implementations§

Source§

impl<F: Clone, Q: Clone, S: Clone> Clone for VectorSearchRequestBuilder<F, Q, S>

Source§

fn clone(&self) -> VectorSearchRequestBuilder<F, Q, S>

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<F: Debug, Q: Debug, S: Debug> Debug for VectorSearchRequestBuilder<F, Q, S>

Source§

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

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

impl<F> Default for VectorSearchRequestBuilder<F, Missing, Missing>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, F, Q, S> Deserialize<'de> for VectorSearchRequestBuilder<F, Q, S>
where F: Deserialize<'de>, Q: Deserialize<'de>, S: Deserialize<'de>,

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<F, Q, S> Serialize for VectorSearchRequestBuilder<F, Q, S>
where F: Serialize, Q: Serialize, S: Serialize,

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§

§

impl<F, Q, S> Freeze for VectorSearchRequestBuilder<F, Q, S>
where Q: Freeze, S: Freeze, F: Freeze,

§

impl<F, Q, S> RefUnwindSafe for VectorSearchRequestBuilder<F, Q, S>
where Q: RefUnwindSafe, S: RefUnwindSafe, F: RefUnwindSafe,

§

impl<F, Q, S> Send for VectorSearchRequestBuilder<F, Q, S>
where Q: Send, S: Send, F: Send,

§

impl<F, Q, S> Sync for VectorSearchRequestBuilder<F, Q, S>
where Q: Sync, S: Sync, F: Sync,

§

impl<F, Q, S> Unpin for VectorSearchRequestBuilder<F, Q, S>
where Q: Unpin, S: Unpin, F: Unpin,

§

impl<F, Q, S> UnsafeUnpin for VectorSearchRequestBuilder<F, Q, S>
where Q: UnsafeUnpin, S: UnsafeUnpin, F: UnsafeUnpin,

§

impl<F, Q, S> UnwindSafe for VectorSearchRequestBuilder<F, Q, S>
where Q: UnwindSafe, S: UnwindSafe, F: UnwindSafe,

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> CloneDebuggableStorage for T
where T: DebuggableStorage + Clone,

Source§

fn clone_storage(&self) -> Box<dyn CloneDebuggableStorage>

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

Source§

fn clone_storage(&self) -> Box<dyn CloneableStorage>

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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: 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> 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.
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> 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> DebuggableStorage for T
where T: Any + Send + Sync + Debug,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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