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

Class: Aws::CloudSearch::Types::Suggester

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

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

{
  suggester_name: "StandardName", # required
  document_suggester_options: { # required
    source_field: "FieldName", # required
    fuzzy_matching: "none", # accepts none, low, high
    sort_expression: "String",
  },
}

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

Instance Attribute Summary collapse

Instance Attribute Details

#document_suggester_optionsTypes::DocumentSuggesterOptions

Options for a search suggester.



2172
2173
2174
2175
2176
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2172

class Suggester < Struct.new(
  :suggester_name,
  :document_suggester_options)
  include Aws::Structure
end

#suggester_nameString

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

Returns:

  • (String)


2172
2173
2174
2175
2176
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2172

class Suggester < Struct.new(
  :suggester_name,
  :document_suggester_options)
  include Aws::Structure
end