Class: Aws::Kendra::Types::AttributeSuggestionsUpdateConfig

Inherits:

Struct

Object
Struct
Aws::Kendra::Types::AttributeSuggestionsUpdateConfig

show all

Defined in:: gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Updates the configuration information for the document fields/attributes that you want to base query suggestions on.

To deactivate using documents fields for query suggestions, set the mode to INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If you set to QUERY, then Amazon Kendra uses the query history to base suggestions on. If you set to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the contents of document fields to base suggestions on.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attribute_suggestions_mode ⇒ String
You can set the mode to ACTIVE or INACTIVE.
#suggestable_config_list ⇒ Array<Types::SuggestableConfig>
The list of fields/attributes that you want to set as suggestible for query suggestions.

Instance Attribute Details

#attribute_suggestions_mode ⇒ `String`

You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig 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.

Returns:

(String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 591

class AttributeSuggestionsUpdateConfig < 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.