Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.Correction

Description

Synopsis

data Correction = Correction' {
- beginOffset :: Maybe Int
- correctedTerm :: Maybe Text
- endOffset :: Maybe Int
- term :: Maybe Text
}
newCorrection :: Correction
correction_beginOffset :: Lens' Correction (Maybe Int)
correction_correctedTerm :: Lens' Correction (Maybe Text)
correction_endOffset :: Lens' Correction (Maybe Int)
correction_term :: Lens' Correction (Maybe Text)

Documentation

data Correction Source #

A corrected misspelled word in a query.

See: newCorrection smart constructor.

Constructors

Correction'
Fields beginOffset :: Maybe Int The zero-based location in the response string or text where the corrected word starts. correctedTerm :: Maybe Text The string or text of a corrected misspelled word in a query. endOffset :: Maybe Int The zero-based location in the response string or text where the corrected word ends. term :: Maybe Text The string or text of a misspelled word in a query.

Instances

Instances details

FromJSON Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods parseJSON :: Value -> Parser Correction # parseJSONList :: Value -> Parser [Correction] #
Generic Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Associated Types type Rep Correction :: Type -> Type # Methods from :: Correction -> Rep Correction x # to :: Rep Correction x -> Correction #
Read Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods readsPrec :: Int -> ReadS Correction # readList :: ReadS [Correction] # readPrec :: ReadPrec Correction # readListPrec :: ReadPrec [Correction] #
Show Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods showsPrec :: Int -> Correction -> ShowS # show :: Correction -> String # showList :: [Correction] -> ShowS #
NFData Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods rnf :: Correction -> () #
Eq Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods (==) :: Correction -> Correction -> Bool # (/=) :: Correction -> Correction -> Bool #
Hashable Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods hashWithSalt :: Int -> Correction -> Int # hash :: Correction -> Int #
type Rep Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction type Rep Correction = D1 ('MetaData "Correction" "Amazonka.Kendra.Types.Correction" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Correction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "correctedTerm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "term") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCorrection :: Correction Source #

Create a value of Correction 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:beginOffset:Correction', correction_beginOffset - The zero-based location in the response string or text where the corrected word starts.

$sel:correctedTerm:Correction', correction_correctedTerm - The string or text of a corrected misspelled word in a query.

$sel:endOffset:Correction', correction_endOffset - The zero-based location in the response string or text where the corrected word ends.

$sel:term:Correction', correction_term - The string or text of a misspelled word in a query.

correction_beginOffset :: Lens' Correction (Maybe Int) Source #

The zero-based location in the response string or text where the corrected word starts.

correction_correctedTerm :: Lens' Correction (Maybe Text) Source #

The string or text of a corrected misspelled word in a query.

correction_endOffset :: Lens' Correction (Maybe Int) Source #

The zero-based location in the response string or text where the corrected word ends.

correction_term :: Lens' Correction (Maybe Text) Source #

The string or text of a misspelled word in a query.