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.SuggestionTextWithHighlights

Description

Documentation

data SuggestionTextWithHighlights Source #

Provides text and information about where to highlight the query suggestion text.

See: newSuggestionTextWithHighlights smart constructor.

Constructors

SuggestionTextWithHighlights'
Fields highlights :: Maybe [SuggestionHighlight] The beginning and end of the query suggestion text that should be highlighted. text :: Maybe Text The query suggestion text to display to the user.

Instances

Instances details

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

newSuggestionTextWithHighlights :: SuggestionTextWithHighlights Source #

Create a value of SuggestionTextWithHighlights 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:highlights:SuggestionTextWithHighlights', suggestionTextWithHighlights_highlights - The beginning and end of the query suggestion text that should be highlighted.

$sel:text:SuggestionTextWithHighlights', suggestionTextWithHighlights_text - The query suggestion text to display to the user.

suggestionTextWithHighlights_highlights :: Lens' SuggestionTextWithHighlights (Maybe [SuggestionHighlight]) Source #

The beginning and end of the query suggestion text that should be highlighted.

suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text) Source #

The query suggestion text to display to the user.