Struct AttributeSuggestionsGetConfig 

#[non_exhaustive]
pub struct AttributeSuggestionsGetConfig {
    pub suggestion_attributes: Option<Vec<String>>,
    pub additional_response_attributes: Option<Vec<String>>,
    pub attribute_filter: Option<AttributeFilter>,
    pub user_context: Option<UserContext>,
}

Provides the configuration information for the document fields/attributes that you want to base query suggestions on.

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.

suggestion_attributes: Option<Vec<String>>

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

additional_response_attributes: Option<Vec<String>>

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

attribute_filter: Option<AttributeFilter>

Filters the search results based on document fields/attributes.

user_context: Option<UserContext>

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

Implementations

impl AttributeSuggestionsGetConfig

pub fn suggestion_attributes(&self) -> &[String]

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .suggestion_attributes.is_none().

pub fn additional_response_attributes(&self) -> &[String]

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_response_attributes.is_none().

pub fn attribute_filter(&self) -> Option<&AttributeFilter>

Filters the search results based on document fields/attributes.

pub fn user_context(&self) -> Option<&UserContext>

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

impl AttributeSuggestionsGetConfig

pub fn builder() -> AttributeSuggestionsGetConfigBuilder

Creates a new builder-style object to manufacture AttributeSuggestionsGetConfig.

Trait Implementations

impl Clone for AttributeSuggestionsGetConfig

fn clone(&self) -> AttributeSuggestionsGetConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeSuggestionsGetConfig

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

Formats the value using the given formatter.

impl PartialEq for AttributeSuggestionsGetConfig

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