Struct SimilaritySingleEmbedding

pub struct SimilaritySingleEmbedding<FILTER: SearchFilter = ()> { /* private fields */ }

A simple, single vector similarity search where it takes the embedding on the current query and returns top_k documents.

Can optionally be used with a filter.

Implementations

impl SimilaritySingleEmbedding<()>

pub fn into_concrete_filter<FILTER: SearchFilter>( &self, ) -> SimilaritySingleEmbedding<FILTER>

Set an optional filter to be used in the query

impl<FILTER: SearchFilter> SimilaritySingleEmbedding<FILTER>

pub fn from_filter(filter: FILTER) -> Self

pub fn with_top_k(&mut self, top_k: u64) -> &mut Self

Set the maximum amount of documents to be returned

pub fn top_k(&self) -> u64

Returns the maximum of documents to be returned

pub fn with_filter<NEWFILTER: SearchFilter>( self, filter: NEWFILTER, ) -> SimilaritySingleEmbedding<NEWFILTER>

Set an optional filter to be used in the query

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

Trait Implementations

impl<FILTER: Clone + SearchFilter> Clone for SimilaritySingleEmbedding<FILTER>

fn clone(&self) -> SimilaritySingleEmbedding<FILTER>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FILTER: Debug + SearchFilter> Debug for SimilaritySingleEmbedding<FILTER>

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

Formats the value using the given formatter.

impl<FILTER: SearchFilter> Default for SimilaritySingleEmbedding<FILTER>

fn default() -> Self

Returns the “default value” for a type.

impl<FILTER: SearchFilter> SearchStrategy for SimilaritySingleEmbedding<FILTER>