Struct VectorSearchRequest

pub struct VectorSearchRequest { /* private fields */ }

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

Implementations

impl VectorSearchRequest

pub fn builder() -> VectorSearchRequestBuilder

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.

Trait Implementations

impl Clone for VectorSearchRequest

fn clone(&self) -> VectorSearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorSearchRequest

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VectorSearchRequest

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.