Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Documentation

data DocumentSuggesterOptions

Options for a search suggester.

See: newDocumentSuggesterOptions smart constructor.

Constructors

DocumentSuggesterOptions'

Fields

• fuzzyMatching :: Maybe SuggesterFuzzyMatching

  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.

• sortExpression :: Maybe Text

  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.

• sourceField :: Text

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

Instances

ToQuery DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

toQuery :: DocumentSuggesterOptions -> QueryString

FromXML DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

parseXML :: [Node] -> Either String DocumentSuggesterOptions

Generic DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Associated Types

type Rep DocumentSuggesterOptions :: Type -> Type

Methods

from :: DocumentSuggesterOptions -> Rep DocumentSuggesterOptions x

to :: Rep DocumentSuggesterOptions x -> DocumentSuggesterOptions

Read DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

readsPrec :: Int -> ReadS DocumentSuggesterOptions

readList :: ReadS [DocumentSuggesterOptions]

readPrec :: ReadPrec DocumentSuggesterOptions

readListPrec :: ReadPrec [DocumentSuggesterOptions]

Show DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

showsPrec :: Int -> DocumentSuggesterOptions -> ShowS

show :: DocumentSuggesterOptions -> String

showList :: [DocumentSuggesterOptions] -> ShowS

NFData DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

rnf :: DocumentSuggesterOptions -> ()

Eq DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

(==) :: DocumentSuggesterOptions -> DocumentSuggesterOptions -> Bool

(/=) :: DocumentSuggesterOptions -> DocumentSuggesterOptions -> Bool

Hashable DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Methods

hashWithSalt :: Int -> DocumentSuggesterOptions -> Int

hash :: DocumentSuggesterOptions -> Int

type Rep DocumentSuggesterOptions

Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions

type Rep DocumentSuggesterOptions = D1 ('MetaData "DocumentSuggesterOptions" "Amazonka.CloudSearch.Types.DocumentSuggesterOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DocumentSuggesterOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fuzzyMatching") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggesterFuzzyMatching)) :*: (S1 ('MetaSel ('Just "sortExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDocumentSuggesterOptions

Arguments

:: Text

$sel:sourceField:DocumentSuggesterOptions'

-> DocumentSuggesterOptions

Create a value of DocumentSuggesterOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fuzzyMatching:DocumentSuggesterOptions', documentSuggesterOptions_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.

$sel:sortExpression:DocumentSuggesterOptions', documentSuggesterOptions_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.

$sel:sourceField:DocumentSuggesterOptions', documentSuggesterOptions_sourceField - The name of the index field you want to use for suggestions.

documentSuggesterOptions_fuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching)

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.

documentSuggesterOptions_sortExpression :: Lens' DocumentSuggesterOptions (Maybe Text)

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.

documentSuggesterOptions_sourceField :: Lens' DocumentSuggesterOptions Text

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