Class: Aws::QBusiness::Types::DocumentAttributeBoostingConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

Note:

DocumentAttributeBoostingConfiguration is a union - when making an API calls you must set exactly one of the members.

Note:

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.

<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

See Also:

Defined Under Namespace

Classes: DateConfiguration, NumberConfiguration, StringConfiguration, StringListConfiguration, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#date_configuration ⇒ Types::DateAttributeBoostingConfiguration

Provides information on boosting ‘DATE` type document attributes.

Returns:



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3009

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.

Returns:



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3009

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.

Returns:



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3009

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.

Returns:



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3009

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

Returns:

  • (Object) —

    the current value of unknown



3009
3010
3011
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3009

def unknown
  @unknown
end