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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

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) 


9208
9209
9210
9211
9212
9213
9214
9215
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9208

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) 


9208
9209
9210
9211
9212
9213
9214
9215
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9208

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) 


9208
9209
9210
9211
9212
9213
9214
9215
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9208

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) 


9208
9209
9210
9211
9212
9213
9214
9215
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9208

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