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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass Search data as a hash:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#displayableBoolean

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

Returns:

  • (Boolean)

5432
5433
5434
5435
5436
5437
5438
5439
# File 'lib/aws-sdk-kendra/types.rb', line 5432

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

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

5432
5433
5434
5435
5436
5437
5438
5439
# File 'lib/aws-sdk-kendra/types.rb', line 5432

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

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

5432
5433
5434
5435
5436
5437
5438
5439
# File 'lib/aws-sdk-kendra/types.rb', line 5432

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

#sortableBoolean

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)

5432
5433
5434
5435
5436
5437
5438
5439
# File 'lib/aws-sdk-kendra/types.rb', line 5432

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