Struct VectorSearchRequest 

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

A vector search request for querying a super::VectorStoreIndex.

The type parameter F specifies the filter type (defaults to Filter<serde_json::Value>). Use VectorSearchRequest::builder() to construct instances.

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

Returns the maximum number of results to return.

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

Returns the optional similarity threshold.

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

Returns a reference to the optional filter expression.

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

where F: Fn(Filter) -> T,

Transforms the filter type using the provided function.

This is useful for converting between filter representations, such as translating the canonical super::request::Filter to a backend-specific filter type.

pub fn try_map_filter<T, F>( self, f: F, ) -> Result<VectorSearchRequest<T>, FilterError>

where F: Fn(Filter) -> Result<T, FilterError>,

Transforms the filter type using a provided function which can additionally return a result.

Useful for converting between filter representations where the conversion can potentially fail (eg, unrepresentable or invalid values).

Trait Implementations

impl<F> Clone for VectorSearchRequest<F>

where F: Clone,

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 for VectorSearchRequest<F>

where F: Debug,

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

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<VectorSearchRequest<F>, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.