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 |
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.
SortingConfiguration' | |
|
Instances
newSortingConfiguration Source #
:: Text | |
-> SortOrder | |
-> 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.