Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearch.Types.DocumentSuggesterOptions

Description

Documentation

data DocumentSuggesterOptions Source #

Options for a search suggester.

See: newDocumentSuggesterOptions smart constructor.

Constructors

DocumentSuggesterOptions'

Fields

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.
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.
sourceField :: Text
The name of the index field you want to use for suggestions.

Instances

Instances details

Eq DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods (==) :: DocumentSuggesterOptions -> DocumentSuggesterOptions -> Bool # (/=) :: DocumentSuggesterOptions -> DocumentSuggesterOptions -> Bool #
Read DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods readsPrec :: Int -> ReadS DocumentSuggesterOptions # readList :: ReadS [DocumentSuggesterOptions] # readPrec :: ReadPrec DocumentSuggesterOptions # readListPrec :: ReadPrec [DocumentSuggesterOptions] #
Show DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods showsPrec :: Int -> DocumentSuggesterOptions -> ShowS # show :: DocumentSuggesterOptions -> String # showList :: [DocumentSuggesterOptions] -> ShowS #
Generic DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Associated Types type Rep DocumentSuggesterOptions :: Type -> Type # Methods from :: DocumentSuggesterOptions -> Rep DocumentSuggesterOptions x # to :: Rep DocumentSuggesterOptions x -> DocumentSuggesterOptions #
NFData DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods rnf :: DocumentSuggesterOptions -> () #
Hashable DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods hashWithSalt :: Int -> DocumentSuggesterOptions -> Int # hash :: DocumentSuggesterOptions -> Int #
ToQuery DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods toQuery :: DocumentSuggesterOptions -> QueryString #
FromXML DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions Methods parseXML :: [Node] -> Either String DocumentSuggesterOptions #
type Rep DocumentSuggesterOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.DocumentSuggesterOptions type Rep DocumentSuggesterOptions = D1 ('MetaData "DocumentSuggesterOptions" "Amazonka.CloudSearch.Types.DocumentSuggesterOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DocumentSuggesterOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sortExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fuzzyMatching") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggesterFuzzyMatching)) :: S1 ('MetaSel ('Just "sourceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDocumentSuggesterOptions Source #

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: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: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:sourceField:DocumentSuggesterOptions', documentSuggesterOptions_sourceField - The name of the index field you want to use for suggestions.

documentSuggesterOptions_sortExpression :: Lens' DocumentSuggesterOptions (Maybe Text) Source #

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_fuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching) Source #

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_sourceField :: Lens' DocumentSuggesterOptions Text Source #

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