Struct SuggestContextQuery

pub struct SuggestContextQuery { /* private fields */ }

The completion suggester considers all documents in the index, but it is often desirable to serve suggestions filtered and/or boosted by some criteria. For example, you want to suggest song titles filtered by certain artists or you want to boost song titles based on their genre.

To achieve suggestion filtering and/or boosting, you can add context mappings while configuring a completion field. You can define multiple context mappings for a completion field. Every context mapping has a unique name and a type. There are two types: category and geo. Context mappings are configured under the contexts parameter in the field mapping.

Implementations

impl SuggestContextQuery

pub fn new<T>(context: T) -> Self

where T: ToString,

Creates an instance of SuggestContextQuery

• context - The value of the category to filter/boost on

pub fn boost<T>(self, boost: T) -> Self

where T: AsPrimitive<f32>,

The factor by which the score of the suggestion should be boosted, the score is computed by multiplying the boost with the suggestion weight, defaults to 1

pub fn prefix(self, prefix: bool) -> Self

Whether the category value should be treated as a prefix or not. For example, if set to true, you can filter category of type1, type2 and so on, by specifying a category prefix of type. Defaults to false

Trait Implementations

impl Clone for SuggestContextQuery

fn clone(&self) -> SuggestContextQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SuggestContextQuery

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

Formats the value using the given formatter.

impl IntoIterator for SuggestContextQuery

type Item = SuggestContextQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<SuggestContextQuery as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for SuggestContextQuery

fn eq(&self, other: &SuggestContextQuery) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SuggestContextQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SuggestContextQuery