Class: Aws::Kendra::Types::AttributeSuggestionsDescribeConfig

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

Overview

Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use [AttributeSuggestionsUpdateConfig] and then call [UpdateQuerySuggestionsConfig].

[1]: docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html [2]: docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_suggestions_mode ⇒ String

The mode is set to either ‘ACTIVE` or `INACTIVE`. If the `Mode` for query history is set to `ENABLED` when calling

UpdateQuerySuggestionsConfig][1

and ‘AttributeSuggestionsMode` to

use fields/attributes is set to ‘ACTIVE`, and you haven’t set your ‘SuggestionTypes` preference to `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the query history.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html

Returns:

  • (String) 


509
510
511
512
513
514
 
# File 'lib/aws-sdk-kendra/types.rb', line 509

class AttributeSuggestionsDescribeConfig < Struct.new(
  :suggestable_config_list,
  :attribute_suggestions_mode)
  SENSITIVE = []
  include Aws::Structure
end

#suggestable_config_list ⇒ Array<Types::SuggestableConfig>

The list of fields/attributes that you want to set as suggestible for query suggestions.

Returns:



509
510
511
512
513
514
 
# File 'lib/aws-sdk-kendra/types.rb', line 509

class AttributeSuggestionsDescribeConfig < Struct.new(
  :suggestable_config_list,
  :attribute_suggestions_mode)
  SENSITIVE = []
  include Aws::Structure
end