class Aws::Kendra::Types::Search

Provides information about how a custom index field is used during a search.

@note When making an API call, you may pass Search

data as a hash:

    {
      facetable: false,
      searchable: false,
      displayable: false,
      sortable: false,
    }

@!attribute [rw] 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`
.
@return [Boolean]

@!attribute [rw] searchable

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.
@return [Boolean]

@!attribute [rw] displayable

Determines whether the field is returned in the query response. The
default is `true`.
@return [Boolean]

@!attribute [rw] 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
`Sortable` set to `true`, Amazon Kendra returns an exception. The
default is `false`.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation

Constants

SENSITIVE