Class: Aws::Kendra::Types::SortingConfiguration

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

Overview

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

  • Date value

  • Long value

  • String value

You can't sort attributes of the following type.

  • String list value

^

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_attribute_key ⇒ String

The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

You can also sort by any of the following built-in attributes:

  • _category

  • _created_at

  • _last_updated_at

  • _version

  • _view_count

Returns:

  • (String) 


9891
9892
9893
9894
9895
9896
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9891

class SortingConfiguration < Struct.new(
  :document_attribute_key,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

  • (String) 


9891
9892
9893
9894
9895
9896
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9891

class SortingConfiguration < Struct.new(
  :document_attribute_key,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end