Struct VectorSearchRequest 

pub struct VectorSearchRequest<F = Filter<Value>> { /* private fields */ }

A vector search request - used in the super::VectorStoreIndex trait.

Implementations

impl<Filter> VectorSearchRequest<Filter>

pub fn builder() -> VectorSearchRequestBuilder<Filter>

Creates a VectorSearchRequestBuilder which you can use to instantiate this struct.

pub fn query(&self) -> &str

The query to be embedded and used in similarity search.

pub fn samples(&self) -> u64

The maximum number of samples that may be returned. If adding a similarity search threshold, you may receive less than the inputted number if there aren’t enough results that satisfy the threshold.

pub fn threshold(&self) -> Option<f64>

pub fn filter(&self) -> &Option<Filter>

pub fn map_filter<T, F>(self, f: F) -> VectorSearchRequest<T>

where F: Fn(Filter) -> T,

Trait Implementations

impl<F: Clone> Clone for VectorSearchRequest<F>

fn clone(&self) -> VectorSearchRequest<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for VectorSearchRequest<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for VectorSearchRequest<F>

where F: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F> Serialize for VectorSearchRequest<F>

where F: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.