Struct HybridSearch

pub struct HybridSearch { /* private fields */ }

A hybrid search strategy that combines a similarity search with a keyword search / sparse search.

Defaults to a a maximum of 10 documents and EmbeddedField::Combined for the field(s).

Implementations

impl HybridSearch

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

Sets the maximum amount of total documents retrieved

pub fn top_k(&self) -> u64

Returns the maximum amount of total documents to be retrieved

pub fn with_top_n(&mut self, top_n: u64) -> &mut Self

Sets the maximum amount of documents to be retrieved per individual query

pub fn top_n(&self) -> u64

Returns the maximum amount of documents per query

pub fn with_dense_vector_field( &mut self, dense_vector_field: impl Into<EmbeddedField>, ) -> &mut Self

Sets the vector field for the dense vector

Defaults to EmbeddedField::Combined

pub fn dense_vector_field(&self) -> &EmbeddedField

Returns the field for the dense vector

pub fn with_sparse_vector_field( &mut self, sparse_vector_field: impl Into<EmbeddedField>, ) -> &mut Self

Sets the vector field for the sparse vector (if applicable)

Defaults to EmbeddedField::Combined

pub fn sparse_vector_field(&self) -> &EmbeddedField

Returns the field for the dense vector

Trait Implementations

impl Clone for HybridSearch

fn clone(&self) -> HybridSearch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HybridSearch

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

Formats the value using the given formatter.

impl Default for HybridSearch

fn default() -> Self

Returns the “default value” for a type.

impl SearchStrategy for HybridSearch