Class: Aws::Kendra::Types::Facet

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

Overview

Information about a document attribute or field. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attribute_key ⇒ String

The unique key for the document attribute.

Returns:

  • (String) 


5154
5155
5156
5157
5158
5159
5160
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5154

class Facet < Struct.new(
  :document_attribute_key,
  :facets,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#facets ⇒ Array<Types::Facet>

An array of document attributes that are nested facets 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. This helps your users further narrow their search.

You can only have one nested facet within a facet. If you want to increase this limit, contact Support.

Returns:



5154
5155
5156
5157
5158
5159
5160
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5154

class Facet < Struct.new(
  :document_attribute_key,
  :facets,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

Returns:

  • (Integer) 


5154
5155
5156
5157
5158
5159
5160
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5154

class Facet < Struct.new(
  :document_attribute_key,
  :facets,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end