/AWS1/CL_QQBSTRATTRBOOSTINGC00

Provides information on boosting STRING type document attributes.

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_boostinglevel TYPE /AWS1/QQBDOCATTRBOOSTINGLEVEL /AWS1/QQBDOCATTRBOOSTINGLEVEL

Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.

Optional arguments:

it_attributevalueboosting TYPE /AWS1/CL_QQBSTRATTRVALBOOSTI00=>TT_STRINGATTRVALUEBOOSTING TT_STRINGATTRVALUEBOOSTING

Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.

---

Queryable Attributes

boostingLevel

Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.

Accessible with the following methods

Method	Description
GET_BOOSTINGLEVEL()	Getter for BOOSTINGLEVEL, with configurable default
ASK_BOOSTINGLEVEL()	Getter for BOOSTINGLEVEL w/ exceptions if field has no value
HAS_BOOSTINGLEVEL()	Determine if BOOSTINGLEVEL has a value

attributeValueBoosting

Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.

Accessible with the following methods

Method	Description
GET_ATTRIBUTEVALUEBOOSTING()	Getter for ATTRIBUTEVALUEBOOSTING, with configurable default
ASK_ATTRIBUTEVALUEBOOSTING()	Getter for ATTRIBUTEVALUEBOOSTING w/ exceptions if field has
HAS_ATTRIBUTEVALUEBOOSTING()	Determine if ATTRIBUTEVALUEBOOSTING has a value