Amazonka.Kendra.Types.TextWithHighlights

Documentation

data TextWithHighlights

Provides text and information about where to highlight the text.

See: newTextWithHighlights smart constructor.

Constructors

TextWithHighlights'

Fields

• highlights :: Maybe [Highlight]

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

• text :: Maybe Text

  The text to display to the user.

Instances

FromJSON TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

parseJSON :: Value -> Parser TextWithHighlights

parseJSONList :: Value -> Parser [TextWithHighlights]

Generic TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Associated Types

type Rep TextWithHighlights :: Type -> Type

Methods

from :: TextWithHighlights -> Rep TextWithHighlights x

to :: Rep TextWithHighlights x -> TextWithHighlights

Read TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

readsPrec :: Int -> ReadS TextWithHighlights

readList :: ReadS [TextWithHighlights]

readPrec :: ReadPrec TextWithHighlights

readListPrec :: ReadPrec [TextWithHighlights]

Show TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

showsPrec :: Int -> TextWithHighlights -> ShowS

show :: TextWithHighlights -> String

showList :: [TextWithHighlights] -> ShowS

NFData TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

rnf :: TextWithHighlights -> ()

Eq TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

(==) :: TextWithHighlights -> TextWithHighlights -> Bool

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

Hashable TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

hashWithSalt :: Int -> TextWithHighlights -> Int

hash :: TextWithHighlights -> Int

type Rep TextWithHighlights

Defined in Amazonka.Kendra.Types.TextWithHighlights

type Rep TextWithHighlights = D1 ('MetaData "TextWithHighlights" "Amazonka.Kendra.Types.TextWithHighlights" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TextWithHighlights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Highlight])) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTextWithHighlights :: TextWithHighlights

Create a value of TextWithHighlights 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:TextWithHighlights', textWithHighlights_highlights - The beginning and end of the text that should be highlighted.

$sel:text:TextWithHighlights', textWithHighlights_text - The text to display to the user.

textWithHighlights_highlights :: Lens' TextWithHighlights (Maybe [Highlight])

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

textWithHighlights_text :: Lens' TextWithHighlights (Maybe Text)

The text to display to the user.