Class: Aws::Kendra::Types::CollapseConfiguration

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

Overview

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attribute_key ⇒ String

The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

Returns:

  • (String) 


1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1258

class CollapseConfiguration < Struct.new(
  :document_attribute_key,
  :sorting_configurations,
  :missing_attribute_key_strategy,
  :expand,
  :expand_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#expand ⇒ Boolean

Specifies whether to expand the collapsed results.

Returns:

  • (Boolean) 


1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1258

class CollapseConfiguration < Struct.new(
  :document_attribute_key,
  :sorting_configurations,
  :missing_attribute_key_strategy,
  :expand,
  :expand_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#expand_configuration ⇒ Types::ExpandConfiguration

Provides configuration information to customize expansion options for a collapsed group.

Returns:



1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1258

class CollapseConfiguration < Struct.new(
  :document_attribute_key,
  :sorting_configurations,
  :missing_attribute_key_strategy,
  :expand,
  :expand_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#missing_attribute_key_strategy ⇒ String

Specifies the behavior for documents without a value for the collapse attribute.

Amazon Kendra offers three customization options:

  • Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

  • Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

  • Choose to EXPAND each document with a null or missing value into a group of its own.

Returns:

  • (String) 


1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1258

class CollapseConfiguration < Struct.new(
  :document_attribute_key,
  :sorting_configurations,
  :missing_attribute_key_strategy,
  :expand,
  :expand_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sorting_configurations ⇒ Array<Types::SortingConfiguration>

A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

Returns:



1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1258

class CollapseConfiguration < Struct.new(
  :document_attribute_key,
  :sorting_configurations,
  :missing_attribute_key_strategy,
  :expand,
  :expand_configuration)
  SENSITIVE = []
  include Aws::Structure
end