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

Class: Aws::CloudSearch::Types::DocumentSuggesterOptions

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DocumentSuggesterOptions as input to an Aws::Client method, you can use a vanilla Hash:

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

Options for a search suggester.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#fuzzy_matchingString

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Possible values:

  • none
  • low
  • high

Returns:

  • (String)

    The level of fuzziness allowed when suggesting matches for a string: none, low, or high.

#sort_expressionString

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 231-1. A document\'s relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Returns:

  • (String)

    An expression that computes a score for each suggestion to control how they are sorted.

#source_fieldString

The name of the index field you want to use for suggestions.

Returns:

  • (String)

    The name of the index field you want to use for suggestions.