Class: Aws::Kendra::Types::AttributeSuggestionsGetConfig

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_response_attributes ⇒ Array<String>

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

Returns:

  • (Array<String>) 


545
546
547
548
549
550
551
552
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 545

class AttributeSuggestionsGetConfig < Struct.new(
  :suggestion_attributes,
  :additional_response_attributes,
  :attribute_filter,
  :user_context)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_filter ⇒ Types::AttributeFilter

Filters the search results based on document fields/attributes.

Returns:



545
546
547
548
549
550
551
552
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 545

class AttributeSuggestionsGetConfig < Struct.new(
  :suggestion_attributes,
  :additional_response_attributes,
  :attribute_filter,
  :user_context)
  SENSITIVE = []
  include Aws::Structure
end

#suggestion_attributes ⇒ Array<String>

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

Returns:

  • (Array<String>) 


545
546
547
548
549
550
551
552
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 545

class AttributeSuggestionsGetConfig < Struct.new(
  :suggestion_attributes,
  :additional_response_attributes,
  :attribute_filter,
  :user_context)
  SENSITIVE = []
  include Aws::Structure
end

#user_context ⇒ Types::UserContext

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

Returns:



545
546
547
548
549
550
551
552
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 545

class AttributeSuggestionsGetConfig < Struct.new(
  :suggestion_attributes,
  :additional_response_attributes,
  :attribute_filter,
  :user_context)
  SENSITIVE = []
  include Aws::Structure
end