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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attribute_keyString

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

Returns:

  • (String)

3509
3510
3511
3512
3513
3514
3515
# File 'lib/aws-sdk-kendra/types.rb', line 3509

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_pairsArray<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.


3509
3510
3511
3512
3513
3514
3515
# File 'lib/aws-sdk-kendra/types.rb', line 3509

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

#document_attribute_value_typeString

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)

3509
3510
3511
3512
3513
3514
3515
# File 'lib/aws-sdk-kendra/types.rb', line 3509

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