Package software.amazon.awssdk.services.cloudsearch.model

Interface DocumentSuggesterOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>, SdkBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>, SdkPojo
Enclosing class:
DocumentSuggesterOptions
public static interface DocumentSuggesterOptions.Builder extends SdkPojo, CopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>

  • Method Details

    • sourceField

      DocumentSuggesterOptions.Builder sourceField(String sourceField)

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

      Parameters:
      sourceField - The name of the index field you want to use for suggestions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fuzzyMatching

      DocumentSuggesterOptions.Builder fuzzyMatching(String fuzzyMatching)

      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.

      Parameters:
      fuzzyMatching - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fuzzyMatching

      DocumentSuggesterOptions.Builder fuzzyMatching(SuggesterFuzzyMatching fuzzyMatching)

      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.

      Parameters:
      fuzzyMatching - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortExpression

      DocumentSuggesterOptions.Builder sortExpression(String sortExpression)

      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 2^31-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.

      Parameters:
      sortExpression - 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 2^31-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:
      Returns a reference to this object so that method calls can be chained together.