amazonka-wisdom-2.0: Amazon Connect Wisdom Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Wisdom.Types.Highlight

Description

 
Synopsis

Documentation

data Highlight Source #

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

See: newHighlight smart constructor.

Constructors

Highlight' 

Fields

Instances

Instances details
FromJSON Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

Generic Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

Associated Types

type Rep Highlight :: Type -> Type #

Read Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

Show Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

NFData Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

Methods

rnf :: Highlight -> () #

Eq Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

Hashable Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

type Rep Highlight Source # 
Instance details

Defined in Amazonka.Wisdom.Types.Highlight

type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Wisdom.Types.Highlight" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffsetInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffsetExclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newHighlight :: Highlight Source #

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:beginOffsetInclusive:Highlight', highlight_beginOffsetInclusive - The offset for the start of the highlight.

$sel:endOffsetExclusive:Highlight', highlight_endOffsetExclusive - The offset for the end of the highlight.

highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the start of the highlight.

highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the end of the highlight.