Class: Aws::QBusiness::Types::StringAttributeBoostingConfiguration

Inherits:

Struct

Object
Struct
Aws::QBusiness::Types::StringAttributeBoostingConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-qbusiness/types.rb

Overview

Provides information on boosting ‘STRING` type document attributes.

<note markdown=“1”> 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][2: 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.

</note>

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

[1]: docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html [2]: docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html [3]: docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attribute_value_boosting ⇒ Hash<String,String>

Specifies specific values of a ‘STRING` type document attribute being boosted.
#boosting_level ⇒ String

Specifies how much a document attribute is boosted.

Instance Attribute Details

#attribute_value_boosting ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 6890

class StringAttributeBoostingConfiguration < Struct.new(
  :boosting_level,
  :attribute_value_boosting)
  SENSITIVE = []
  include Aws::Structure
end

#boosting_level ⇒ `String`

Specifies how much a document attribute is boosted.