Class: Aws::Kendra::Types::DocumentAttributeValueCountPair

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

Overview

Provides the count of documents that match a particular document attribute or field when doing a faceted search.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ Integer

The number of documents in the response that have the attribute/field value for the key.

Returns:

  • (Integer) 


4705
4706
4707
4708
4709
4710
4711
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4705

class DocumentAttributeValueCountPair < Struct.new(
  :document_attribute_value,
  :count,
  :facet_results)
  SENSITIVE = []
  include Aws::Structure
end

#document_attribute_value ⇒ Types::DocumentAttributeValue

The value of the attribute/field. For example, "HR".

Returns:



4705
4706
4707
4708
4709
4710
4711
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4705

class DocumentAttributeValueCountPair < Struct.new(
  :document_attribute_value,
  :count,
  :facet_results)
  SENSITIVE = []
  include Aws::Structure
end

#facet_results ⇒ Array<Types::FacetResult>

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Returns:



4705
4706
4707
4708
4709
4710
4711
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4705

class DocumentAttributeValueCountPair < Struct.new(
  :document_attribute_value,
  :count,
  :facet_results)
  SENSITIVE = []
  include Aws::Structure
end