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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::Search

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #displayable ⇒ 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.

• #searchable ⇒ 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.

Instance Attribute Details

#displayable ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9154

class Search < Struct.new(
  :facetable,
  :searchable,
  :displayable,
  :sortable)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9154

class Search < Struct.new(
  :facetable,
  :searchable,
  :displayable,
  :sortable)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9154

class Search < Struct.new(
  :facetable,
  :searchable,
  :displayable,
  :sortable)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9154

class Search < Struct.new(
  :facetable,
  :searchable,
  :displayable,
  :sortable)
  SENSITIVE = []
  include Aws::Structure
end