Class: Aws::QBusiness::Types::DocumentAttributeBoostingConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::DocumentAttributeBoostingConfiguration
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
DocumentAttributeBoostingConfiguration is a union - when making an API calls you must set exactly one of the members.
DocumentAttributeBoostingConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DocumentAttributeBoostingConfiguration corresponding to the set member.
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.
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.
Direct Known Subclasses
DateConfiguration, NumberConfiguration, StringConfiguration, StringListConfiguration, Unknown
Defined Under Namespace
Classes: DateConfiguration, NumberConfiguration, StringConfiguration, StringListConfiguration, Unknown
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#date_configuration ⇒ Types::DateAttributeBoostingConfiguration
Provides information on boosting
DATE
type document attributes. -
#number_configuration ⇒ Types::NumberAttributeBoostingConfiguration
Provides information on boosting
NUMBER
type document attributes. -
#string_configuration ⇒ Types::StringAttributeBoostingConfiguration
Provides information on boosting
STRING
type document attributes. -
#string_list_configuration ⇒ Types::StringListAttributeBoostingConfiguration
Provides information on boosting
STRING_LIST
type document attributes. -
#unknown ⇒ Object
Returns the value of attribute unknown.
Instance Attribute Details
#date_configuration ⇒ Types::DateAttributeBoostingConfiguration
Provides information on boosting DATE
type document attributes.
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352 class DocumentAttributeBoostingConfiguration < Struct.new( :number_configuration, :string_configuration, :date_configuration, :string_list_configuration, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class NumberConfiguration < DocumentAttributeBoostingConfiguration; end class StringConfiguration < DocumentAttributeBoostingConfiguration; end class DateConfiguration < DocumentAttributeBoostingConfiguration; end class StringListConfiguration < DocumentAttributeBoostingConfiguration; end class Unknown < DocumentAttributeBoostingConfiguration; end end |
#number_configuration ⇒ Types::NumberAttributeBoostingConfiguration
Provides information on boosting NUMBER
type document attributes.
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352 class DocumentAttributeBoostingConfiguration < Struct.new( :number_configuration, :string_configuration, :date_configuration, :string_list_configuration, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class NumberConfiguration < DocumentAttributeBoostingConfiguration; end class StringConfiguration < DocumentAttributeBoostingConfiguration; end class DateConfiguration < DocumentAttributeBoostingConfiguration; end class StringListConfiguration < DocumentAttributeBoostingConfiguration; end class Unknown < DocumentAttributeBoostingConfiguration; end end |
#string_configuration ⇒ Types::StringAttributeBoostingConfiguration
Provides information on boosting STRING
type document attributes.
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352 class DocumentAttributeBoostingConfiguration < Struct.new( :number_configuration, :string_configuration, :date_configuration, :string_list_configuration, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class NumberConfiguration < DocumentAttributeBoostingConfiguration; end class StringConfiguration < DocumentAttributeBoostingConfiguration; end class DateConfiguration < DocumentAttributeBoostingConfiguration; end class StringListConfiguration < DocumentAttributeBoostingConfiguration; end class Unknown < DocumentAttributeBoostingConfiguration; end end |
#string_list_configuration ⇒ Types::StringListAttributeBoostingConfiguration
Provides information on boosting STRING_LIST
type document
attributes.
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352 class DocumentAttributeBoostingConfiguration < Struct.new( :number_configuration, :string_configuration, :date_configuration, :string_list_configuration, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class NumberConfiguration < DocumentAttributeBoostingConfiguration; end class StringConfiguration < DocumentAttributeBoostingConfiguration; end class DateConfiguration < DocumentAttributeBoostingConfiguration; end class StringListConfiguration < DocumentAttributeBoostingConfiguration; end class Unknown < DocumentAttributeBoostingConfiguration; end end |
#unknown ⇒ Object
Returns the value of attribute unknown
2352 2353 2354 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352 def unknown @unknown end |