Skip to content

SortingConfiguration

Used by
Source code in docs_src/capo_kendra/types/sorting_configuration.py 
14
15
16
17
18
19
20
class SortingConfiguration(TypedDict, closed=True):
    document_attribute_key: (
        "capo_kendra.types.document_attribute_key.DocumentAttributeKey"
    )
    """<p>The name of the document attribute used to sort the response. You can use any field that has the <code>Sortable</code> flag set to true.</p> <p>You can also sort by any of the following built-in attributes:</p> <ul> <li> <p>_category</p> </li> <li> <p>_created_at</p> </li> <li> <p>_last_updated_at</p> </li> <li> <p>_version</p> </li> <li> <p>_view_count</p> </li> </ul>"""
    sort_order: "capo_kendra.types.sort_order.SortOrder"
    """<p>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.</p>"""

document_attribute_key instance-attribute 

document_attribute_key: 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

sort_order instance-attribute 

sort_order: 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.