DocumentAttributeBoostingConfiguration¶
Union Type¶
module-attribute
¶
DocumentAttributeBoostingConfiguration = Union[DocumentAttributeBoostingConfigurationNumberConfiguration | DocumentAttributeBoostingConfigurationStringConfiguration | DocumentAttributeBoostingConfigurationDateConfiguration | DocumentAttributeBoostingConfigurationStringListConfiguration | DocumentAttributeBoostingConfigurationUnknown]
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.
Note
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.
Union Member Types¶
dataclass
¶
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.
Attributes¶
dataclass
¶
Provides information on boosting STRING type document attributes.
Version 2 assigns priority tiers to STRING attributes, establishing
clear hierarchical relationships with other boosted attributes.
Attributes¶
dataclass
¶
Provides information on boosting DATE type document attributes.
Version 2 assigns priority tiers to DATE attributes, establishing
clear hierarchical relationships with other boosted attributes.
Attributes¶
dataclass
¶
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.