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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::FacetResult

Defined in:

(unknown)

Overview

The facet values for the documents in the response.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #document_attribute_key ⇒ String

  The key for the facet values.

• #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.

• #document_attribute_value_type ⇒ String

  The data type of the facet value.

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) —

  The key for the facet values.

#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:

• (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.

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

Possible values:

• STRING_VALUE
• STRING_LIST_VALUE
• LONG_VALUE
• DATE_VALUE

Returns:

• (String) —

  The data type of the facet value.