Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.SortingConfiguration

Description

Synopsis

data SortingConfiguration = SortingConfiguration' {
- documentAttributeKey :: Text
- sortOrder :: SortOrder
}
newSortingConfiguration :: Text -> SortOrder -> SortingConfiguration
sortingConfiguration_documentAttributeKey :: Lens' SortingConfiguration Text
sortingConfiguration_sortOrder :: Lens' SortingConfiguration SortOrder

Documentation

data SortingConfiguration Source #

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: newSortingConfiguration smart constructor.

Constructors

SortingConfiguration'

Fields

documentAttributeKey :: Text
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
sortOrder :: SortOrder
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.

Instances

Instances details

ToJSON SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods toJSON :: SortingConfiguration -> Value # toEncoding :: SortingConfiguration -> Encoding # toJSONList :: [SortingConfiguration] -> Value # toEncodingList :: [SortingConfiguration] -> Encoding #
Generic SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Associated Types type Rep SortingConfiguration :: Type -> Type # Methods from :: SortingConfiguration -> Rep SortingConfiguration x # to :: Rep SortingConfiguration x -> SortingConfiguration #
Read SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods readsPrec :: Int -> ReadS SortingConfiguration # readList :: ReadS [SortingConfiguration] # readPrec :: ReadPrec SortingConfiguration # readListPrec :: ReadPrec [SortingConfiguration] #
Show SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods showsPrec :: Int -> SortingConfiguration -> ShowS # show :: SortingConfiguration -> String # showList :: [SortingConfiguration] -> ShowS #
NFData SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods rnf :: SortingConfiguration -> () #
Eq SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods (==) :: SortingConfiguration -> SortingConfiguration -> Bool # (/=) :: SortingConfiguration -> SortingConfiguration -> Bool #
Hashable SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods hashWithSalt :: Int -> SortingConfiguration -> Int # hash :: SortingConfiguration -> Int #
type Rep SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration type Rep SortingConfiguration = D1 ('MetaData "SortingConfiguration" "Amazonka.Kendra.Types.SortingConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SortingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SortOrder)))

newSortingConfiguration Source #

Arguments

:: Text	`$sel:documentAttributeKey:SortingConfiguration'`
-> SortOrder	`$sel:sortOrder:SortingConfiguration'`
-> SortingConfiguration

Create a value of SortingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentAttributeKey:SortingConfiguration', sortingConfiguration_documentAttributeKey - 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

$sel:sortOrder:SortingConfiguration', sortingConfiguration_sortOrder - 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.

sortingConfiguration_documentAttributeKey :: Lens' SortingConfiguration Text Source #

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

sortingConfiguration_sortOrder :: Lens' SortingConfiguration SortOrder Source #

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.