Class: Aws::Kendra::Types::FacetResult

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

Overview

The facet values for the documents in the response.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attribute_key ⇒ String

The key for the facet values. This is the same as the ‘DocumentAttributeKey` provided in the query.

Returns:

  • (String) 


5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/aws-sdk-kendra/types.rb', line 5182

class FacetResult < Struct.new(
  :document_attribute_key,
  :document_attribute_value_type,
  :document_attribute_value_count_pairs)
  SENSITIVE = []
  include Aws::Structure
end

#document_attribute_value_count_pairs ⇒ Array<Types::DocumentAttributeValueCountPair>

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Returns:



5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/aws-sdk-kendra/types.rb', line 5182

class FacetResult < Struct.new(
  :document_attribute_key,
  :document_attribute_value_type,
  :document_attribute_value_count_pairs)
  SENSITIVE = []
  include Aws::Structure
end

#document_attribute_value_type ⇒ String

The data type of the facet value. This is the same as the type defined for the index field when it was created.

Returns:

  • (String) 


5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/aws-sdk-kendra/types.rb', line 5182

class FacetResult < Struct.new(
  :document_attribute_key,
  :document_attribute_value_type,
  :document_attribute_value_count_pairs)
  SENSITIVE = []
  include Aws::Structure
end