Struct QueryExpansionInfo 

#[non_exhaustive]
pub struct QueryExpansionInfo {
    pub expanded_query: bool,
    pub pinned_result_count: i64,
    /* private fields */
}

Available on crate features conversational-search-service or search-service only.

Information describing query expansion including whether expansion has occurred.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

expanded_query: bool

Bool describing whether query expansion has occurred.

pinned_result_count: i64

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

Implementations

impl QueryExpansionInfo

pub fn new() -> Self

pub fn set_expanded_query<T: Into<bool>>(self, v: T) -> Self

Sets the value of expanded_query.

Example

let x = QueryExpansionInfo::new().set_expanded_query(true);

pub fn set_pinned_result_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of pinned_result_count.

Example

let x = QueryExpansionInfo::new().set_pinned_result_count(42);

Trait Implementations

impl Clone for QueryExpansionInfo

fn clone(&self) -> QueryExpansionInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryExpansionInfo

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

Formats the value using the given formatter.

impl Default for QueryExpansionInfo

fn default() -> QueryExpansionInfo

Returns the “default value” for a type.

impl Message for QueryExpansionInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for QueryExpansionInfo

fn eq(&self, other: &QueryExpansionInfo) -> 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 StructuralPartialEq for QueryExpansionInfo