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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/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)


4441
4442
4443
4444
4445
4446
4447
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4441

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.



4441
4442
4443
4444
4445
4446
4447
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4441

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)


4441
4442
4443
4444
4445
4446
4447
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4441

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