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 |
Synopsis
- data Highlight = Highlight' {
- topAnswer :: Maybe Bool
- type' :: Maybe HighlightType
- beginOffset :: Int
- endOffset :: Int
- newHighlight :: Int -> Int -> Highlight
- highlight_topAnswer :: Lens' Highlight (Maybe Bool)
- highlight_type :: Lens' Highlight (Maybe HighlightType)
- highlight_beginOffset :: Lens' Highlight Int
- highlight_endOffset :: Lens' Highlight Int
Documentation
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.
Highlight' | |
|
Instances
FromJSON Highlight Source # | |
Generic Highlight Source # | |
Read Highlight Source # | |
Show Highlight Source # | |
NFData Highlight Source # | |
Defined in Amazonka.Kendra.Types.Highlight | |
Eq Highlight Source # | |
Hashable Highlight Source # | |
Defined in Amazonka.Kendra.Types.Highlight | |
type Rep Highlight Source # | |
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)))) |
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) Source #
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
highlight_type :: Lens' Highlight (Maybe HighlightType) Source #
The highlight type.