Enum DocumentAttributeBoostingConfiguration 

#[non_exhaustive]
pub enum DocumentAttributeBoostingConfiguration {
    DateConfiguration(DateAttributeBoostingConfiguration),
    NumberConfiguration(NumberAttributeBoostingConfiguration),
    StringConfiguration(StringAttributeBoostingConfiguration),
    StringListConfiguration(StringListAttributeBoostingConfiguration),
    #[non_exhaustive]
    Unknown,
}

Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.

In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.

For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DateConfiguration(DateAttributeBoostingConfiguration)

Provides information on boosting DATE type document attributes.

Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.

NumberConfiguration(NumberAttributeBoostingConfiguration)

Provides information on boosting NUMBER type document attributes.

NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.

StringConfiguration(StringAttributeBoostingConfiguration)

Provides information on boosting STRING type document attributes.

Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.

StringListConfiguration(StringListAttributeBoostingConfiguration)

Provides information on boosting STRING_LIST type document attributes.

STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl DocumentAttributeBoostingConfiguration

pub fn as_date_configuration( &self, ) -> Result<&DateAttributeBoostingConfiguration, &Self>

Tries to convert the enum instance into DateConfiguration, extracting the inner DateAttributeBoostingConfiguration. Returns Err(&Self) if it can’t be converted.

pub fn is_date_configuration(&self) -> bool

Returns true if this is a DateConfiguration.

pub fn as_number_configuration( &self, ) -> Result<&NumberAttributeBoostingConfiguration, &Self>

Tries to convert the enum instance into NumberConfiguration, extracting the inner NumberAttributeBoostingConfiguration. Returns Err(&Self) if it can’t be converted.

pub fn is_number_configuration(&self) -> bool

Returns true if this is a NumberConfiguration.

pub fn as_string_configuration( &self, ) -> Result<&StringAttributeBoostingConfiguration, &Self>

Tries to convert the enum instance into StringConfiguration, extracting the inner StringAttributeBoostingConfiguration. Returns Err(&Self) if it can’t be converted.

pub fn is_string_configuration(&self) -> bool

Returns true if this is a StringConfiguration.

pub fn as_string_list_configuration( &self, ) -> Result<&StringListAttributeBoostingConfiguration, &Self>

Tries to convert the enum instance into StringListConfiguration, extracting the inner StringListAttributeBoostingConfiguration. Returns Err(&Self) if it can’t be converted.

pub fn is_string_list_configuration(&self) -> bool

Returns true if this is a StringListConfiguration.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for DocumentAttributeBoostingConfiguration

fn clone(&self) -> DocumentAttributeBoostingConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentAttributeBoostingConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DocumentAttributeBoostingConfiguration

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