StringAttributeBoostingConfiguration

Provides information on boosting STRING type document attributes.

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.

Contents

boostingLevel

Specifies how much a document attribute is boosted.

Type: String

Valid Values: NONE | LOW | MEDIUM | HIGH | VERY_HIGH

Required: Yes

attributeValueBoosting

Specifies specific values of a STRING type document attribute being boosted.

Type: String to string map

Map Entries: Maximum number of 10 items.

Key Length Constraints: Minimum length of 1. Maximum length of 2048.

Valid Values: LOW | MEDIUM | HIGH | VERY_HIGH

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3