Amazonka.Kendra.Types.SuggestionTextWithHighlights

Documentation

data SuggestionTextWithHighlights

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

FromJSON SuggestionTextWithHighlights

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

parseJSON :: Value -> Parser SuggestionTextWithHighlights

parseJSONList :: Value -> Parser [SuggestionTextWithHighlights]

Generic SuggestionTextWithHighlights

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

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

readsPrec :: Int -> ReadS SuggestionTextWithHighlights

readList :: ReadS [SuggestionTextWithHighlights]

readPrec :: ReadPrec SuggestionTextWithHighlights

readListPrec :: ReadPrec [SuggestionTextWithHighlights]

Show SuggestionTextWithHighlights

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

showsPrec :: Int -> SuggestionTextWithHighlights -> ShowS

show :: SuggestionTextWithHighlights -> String

showList :: [SuggestionTextWithHighlights] -> ShowS

NFData SuggestionTextWithHighlights

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

rnf :: SuggestionTextWithHighlights -> ()

Eq SuggestionTextWithHighlights

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

(==) :: SuggestionTextWithHighlights -> SuggestionTextWithHighlights -> Bool

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

Hashable SuggestionTextWithHighlights

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Methods

hashWithSalt :: Int -> SuggestionTextWithHighlights -> Int

hash :: SuggestionTextWithHighlights -> Int

type Rep SuggestionTextWithHighlights

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

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])

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

suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text)

The query suggestion text to display to the user.