Amazonka.Kendra.Types.SpellCorrectionConfiguration

Documentation

data SpellCorrectionConfiguration

Provides the configuration information for suggested query spell corrections.

Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.

This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation.

See: newSpellCorrectionConfiguration smart constructor.

Constructors

SpellCorrectionConfiguration'

Fields

• includeQuerySpellCheckSuggestions :: Bool

  TRUE to suggest spell corrections for queries.

Instances

ToJSON SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

toJSON :: SpellCorrectionConfiguration -> Value

toEncoding :: SpellCorrectionConfiguration -> Encoding

toJSONList :: [SpellCorrectionConfiguration] -> Value

toEncodingList :: [SpellCorrectionConfiguration] -> Encoding

Generic SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Associated Types

type Rep SpellCorrectionConfiguration :: Type -> Type

Methods

from :: SpellCorrectionConfiguration -> Rep SpellCorrectionConfiguration x

to :: Rep SpellCorrectionConfiguration x -> SpellCorrectionConfiguration

Read SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

readsPrec :: Int -> ReadS SpellCorrectionConfiguration

readList :: ReadS [SpellCorrectionConfiguration]

readPrec :: ReadPrec SpellCorrectionConfiguration

readListPrec :: ReadPrec [SpellCorrectionConfiguration]

Show SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

showsPrec :: Int -> SpellCorrectionConfiguration -> ShowS

show :: SpellCorrectionConfiguration -> String

showList :: [SpellCorrectionConfiguration] -> ShowS

NFData SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

rnf :: SpellCorrectionConfiguration -> ()

Eq SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

(==) :: SpellCorrectionConfiguration -> SpellCorrectionConfiguration -> Bool

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

Hashable SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Methods

hashWithSalt :: Int -> SpellCorrectionConfiguration -> Int

hash :: SpellCorrectionConfiguration -> Int

type Rep SpellCorrectionConfiguration

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

type Rep SpellCorrectionConfiguration = D1 ('MetaData "SpellCorrectionConfiguration" "Amazonka.Kendra.Types.SpellCorrectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SpellCorrectionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeQuerySpellCheckSuggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newSpellCorrectionConfiguration

Arguments

:: Bool

$sel:includeQuerySpellCheckSuggestions:SpellCorrectionConfiguration'

-> SpellCorrectionConfiguration

Create a value of SpellCorrectionConfiguration 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:includeQuerySpellCheckSuggestions:SpellCorrectionConfiguration', spellCorrectionConfiguration_includeQuerySpellCheckSuggestions - TRUE to suggest spell corrections for queries.

spellCorrectionConfiguration_includeQuerySpellCheckSuggestions :: Lens' SpellCorrectionConfiguration Bool

TRUE to suggest spell corrections for queries.