Search
Provides information about how a custom index field is used during a search.
Contents
- Displayable
-
Determines whether the field is returned in the query response. The default is
true.Type: Boolean
Required: No
- Facetable
-
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.Type: Boolean
Required: No
- Searchable
-
Determines whether the field is used in the search. If the
Searchablefield istrue, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istruefor string fields andfalsefor number and date fields.Type: Boolean
Required: No
- Sortable
-
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
Sortableset totrue, Amazon Kendra returns an exception. The default isfalse.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
