pub struct HybridSearch<FILTER: SearchFilter = ()> { /* private fields */ }Expand description
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§
Source§impl<FILTER: SearchFilter> HybridSearch<FILTER>
impl<FILTER: SearchFilter> HybridSearch<FILTER>
Sourcepub fn from_filter(filter: FILTER) -> Self
pub fn from_filter(filter: FILTER) -> Self
Creates a new hybrid search strategy that uses the provided filter
pub fn with_filter<NEWFILTER: SearchFilter>( self, filter: NEWFILTER, ) -> HybridSearch<NEWFILTER>
Sourcepub fn with_top_k(&mut self, top_k: u64) -> &mut Self
pub fn with_top_k(&mut self, top_k: u64) -> &mut Self
Sets the maximum amount of total documents retrieved
Sourcepub fn with_top_n(&mut self, top_n: u64) -> &mut Self
pub fn with_top_n(&mut self, top_n: u64) -> &mut Self
Sets the maximum amount of documents to be retrieved per individual query
Sourcepub fn with_dense_vector_field(
&mut self,
dense_vector_field: impl Into<EmbeddedField>,
) -> &mut Self
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
Sourcepub fn dense_vector_field(&self) -> &EmbeddedField
pub fn dense_vector_field(&self) -> &EmbeddedField
Returns the field for the dense vector
Sourcepub fn with_sparse_vector_field(
&mut self,
sparse_vector_field: impl Into<EmbeddedField>,
) -> &mut Self
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
Sourcepub fn sparse_vector_field(&self) -> &EmbeddedField
pub fn sparse_vector_field(&self) -> &EmbeddedField
Returns the field for the dense vector
pub fn filter(&self) -> Option<&FILTER>
Trait Implementations§
Source§impl<FILTER: Clone + SearchFilter> Clone for HybridSearch<FILTER>
impl<FILTER: Clone + SearchFilter> Clone for HybridSearch<FILTER>
Source§fn clone(&self) -> HybridSearch<FILTER>
fn clone(&self) -> HybridSearch<FILTER>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<FILTER: Debug + SearchFilter> Debug for HybridSearch<FILTER>
impl<FILTER: Debug + SearchFilter> Debug for HybridSearch<FILTER>
Source§impl<FILTER: SearchFilter> Default for HybridSearch<FILTER>
impl<FILTER: SearchFilter> Default for HybridSearch<FILTER>
impl<FILTER: SearchFilter> SearchStrategy for HybridSearch<FILTER>
Auto Trait Implementations§
impl<FILTER> Freeze for HybridSearch<FILTER>where
FILTER: Freeze,
impl<FILTER> RefUnwindSafe for HybridSearch<FILTER>where
FILTER: RefUnwindSafe,
impl<FILTER> Send for HybridSearch<FILTER>
impl<FILTER> Sync for HybridSearch<FILTER>
impl<FILTER> Unpin for HybridSearch<FILTER>where
FILTER: Unpin,
impl<FILTER> UnwindSafe for HybridSearch<FILTER>where
FILTER: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);