Amazonka.Kendra.Types.Highlight

Documentation

data Highlight

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See: newHighlight smart constructor.

Constructors

Highlight'

Fields

• topAnswer :: Maybe Bool

  Indicates whether the response is the best response. True if this is the best response; otherwise, false.

• type' :: Maybe HighlightType

  The highlight type.

• beginOffset :: Int

  The zero-based location in the response string where the highlight starts.

• endOffset :: Int

  The zero-based location in the response string where the highlight ends.

Instances

FromJSON Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

parseJSON :: Value -> Parser Highlight

parseJSONList :: Value -> Parser [Highlight]

Generic Highlight

Defined in Amazonka.Kendra.Types.Highlight

Associated Types

type Rep Highlight :: Type -> Type

Methods

from :: Highlight -> Rep Highlight x

to :: Rep Highlight x -> Highlight

Read Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

readsPrec :: Int -> ReadS Highlight

readList :: ReadS [Highlight]

readPrec :: ReadPrec Highlight

readListPrec :: ReadPrec [Highlight]

Show Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

showsPrec :: Int -> Highlight -> ShowS

show :: Highlight -> String

showList :: [Highlight] -> ShowS

NFData Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

rnf :: Highlight -> ()

Eq Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

(==) :: Highlight -> Highlight -> Bool

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

Hashable Highlight

Defined in Amazonka.Kendra.Types.Highlight

Methods

hashWithSalt :: Int -> Highlight -> Int

hash :: Highlight -> Int

type Rep Highlight

Defined in Amazonka.Kendra.Types.Highlight

type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Kendra.Types.Highlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HighlightType))) :*: (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newHighlight

Arguments

:: Int

$sel:beginOffset:Highlight'

-> Int

$sel:endOffset:Highlight'

-> Highlight

Create a value of Highlight 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:topAnswer:Highlight', highlight_topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.

$sel:type':Highlight', highlight_type - The highlight type.

$sel:beginOffset:Highlight', highlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:Highlight', highlight_endOffset - The zero-based location in the response string where the highlight ends.

highlight_topAnswer :: Lens' Highlight (Maybe Bool)

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

highlight_type :: Lens' Highlight (Maybe HighlightType)

The highlight type.

highlight_beginOffset :: Lens' Highlight Int

The zero-based location in the response string where the highlight starts.

highlight_endOffset :: Lens' Highlight Int

The zero-based location in the response string where the highlight ends.