Skip to content

Search

Source code in docs_src/capo_kendra/types/search.py 
11
12
13
14
15
16
17
18
19
class Search(TypedDict, closed=True):
    facetable: "capo_kendra.types.boolean.Boolean"
    """<p>Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is <code>false</code> .</p>"""
    searchable: "capo_kendra.types.boolean.Boolean"
    """<p>Determines whether the field is used in the search. If the <code>Searchable</code> field is <code>true</code>, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is <code>true</code> for string fields and <code>false</code> for number and date fields.</p>"""
    displayable: "capo_kendra.types.boolean.Boolean"
    """<p>Determines whether the field is returned in the query response. The default is <code>true</code>.</p>"""
    sortable: "capo_kendra.types.boolean.Boolean"
    """<p>Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have <code>Sortable</code> set to <code>true</code>, Amazon Kendra returns an exception. The default is <code>false</code>.</p>"""

displayable instance-attribute 

displayable: Boolean

Determines whether the field is returned in the query response. The default is true.

facetable instance-attribute 

facetable: Boolean

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

searchable instance-attribute 

searchable: Boolean

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

sortable instance-attribute 

sortable: Boolean

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.