AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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,
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#displayableBoolean

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.

#facetableBoolean

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.

#searchableBoolean

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.