You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::Search

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Search as input to an Aws::Client method, you can use a vanilla Hash:

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

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#displayable ⇒ Boolean

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

Returns:

  • (Boolean) —

    Determines whether the field is returned in the query response.

#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 .

Returns:

  • (Boolean) —

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

#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.

Returns:

  • (Boolean) —

    Determines whether the field is used in the search.

#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.

Returns:

  • (Boolean) —

    Determines whether the field can be used to sort the results of a query.