{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Kendra.Types.SuggestionTextWithHighlights
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Kendra.Types.SuggestionTextWithHighlights where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types.SuggestionHighlight
import qualified Amazonka.Prelude as Prelude

-- | Provides text and information about where to highlight the query
-- suggestion text.
--
-- /See:/ 'newSuggestionTextWithHighlights' smart constructor.
data SuggestionTextWithHighlights = SuggestionTextWithHighlights'
  { -- | The beginning and end of the query suggestion text that should be
    -- highlighted.
    SuggestionTextWithHighlights -> Maybe [SuggestionHighlight]
highlights :: Prelude.Maybe [SuggestionHighlight],
    -- | The query suggestion text to display to the user.
    SuggestionTextWithHighlights -> Maybe Text
text :: Prelude.Maybe Prelude.Text
  }
  deriving (SuggestionTextWithHighlights
-> SuggestionTextWithHighlights -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SuggestionTextWithHighlights
-> SuggestionTextWithHighlights -> Bool
$c/= :: SuggestionTextWithHighlights
-> SuggestionTextWithHighlights -> Bool
== :: SuggestionTextWithHighlights
-> SuggestionTextWithHighlights -> Bool
$c== :: SuggestionTextWithHighlights
-> SuggestionTextWithHighlights -> Bool
Prelude.Eq, ReadPrec [SuggestionTextWithHighlights]
ReadPrec SuggestionTextWithHighlights
Int -> ReadS SuggestionTextWithHighlights
ReadS [SuggestionTextWithHighlights]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SuggestionTextWithHighlights]
$creadListPrec :: ReadPrec [SuggestionTextWithHighlights]
readPrec :: ReadPrec SuggestionTextWithHighlights
$creadPrec :: ReadPrec SuggestionTextWithHighlights
readList :: ReadS [SuggestionTextWithHighlights]
$creadList :: ReadS [SuggestionTextWithHighlights]
readsPrec :: Int -> ReadS SuggestionTextWithHighlights
$creadsPrec :: Int -> ReadS SuggestionTextWithHighlights
Prelude.Read, Int -> SuggestionTextWithHighlights -> ShowS
[SuggestionTextWithHighlights] -> ShowS
SuggestionTextWithHighlights -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SuggestionTextWithHighlights] -> ShowS
$cshowList :: [SuggestionTextWithHighlights] -> ShowS
show :: SuggestionTextWithHighlights -> String
$cshow :: SuggestionTextWithHighlights -> String
showsPrec :: Int -> SuggestionTextWithHighlights -> ShowS
$cshowsPrec :: Int -> SuggestionTextWithHighlights -> ShowS
Prelude.Show, forall x.
Rep SuggestionTextWithHighlights x -> SuggestionTextWithHighlights
forall x.
SuggestionTextWithHighlights -> Rep SuggestionTextWithHighlights x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SuggestionTextWithHighlights x -> SuggestionTextWithHighlights
$cfrom :: forall x.
SuggestionTextWithHighlights -> Rep SuggestionTextWithHighlights x
Prelude.Generic)

-- |
-- Create a value of 'SuggestionTextWithHighlights' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'highlights', 'suggestionTextWithHighlights_highlights' - The beginning and end of the query suggestion text that should be
-- highlighted.
--
-- 'text', 'suggestionTextWithHighlights_text' - The query suggestion text to display to the user.
newSuggestionTextWithHighlights ::
  SuggestionTextWithHighlights
newSuggestionTextWithHighlights :: SuggestionTextWithHighlights
newSuggestionTextWithHighlights =
  SuggestionTextWithHighlights'
    { $sel:highlights:SuggestionTextWithHighlights' :: Maybe [SuggestionHighlight]
highlights =
        forall a. Maybe a
Prelude.Nothing,
      $sel:text:SuggestionTextWithHighlights' :: Maybe Text
text = forall a. Maybe a
Prelude.Nothing
    }

-- | The beginning and end of the query suggestion text that should be
-- highlighted.
suggestionTextWithHighlights_highlights :: Lens.Lens' SuggestionTextWithHighlights (Prelude.Maybe [SuggestionHighlight])
suggestionTextWithHighlights_highlights :: Lens' SuggestionTextWithHighlights (Maybe [SuggestionHighlight])
suggestionTextWithHighlights_highlights = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuggestionTextWithHighlights' {Maybe [SuggestionHighlight]
highlights :: Maybe [SuggestionHighlight]
$sel:highlights:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe [SuggestionHighlight]
highlights} -> Maybe [SuggestionHighlight]
highlights) (\s :: SuggestionTextWithHighlights
s@SuggestionTextWithHighlights' {} Maybe [SuggestionHighlight]
a -> SuggestionTextWithHighlights
s {$sel:highlights:SuggestionTextWithHighlights' :: Maybe [SuggestionHighlight]
highlights = Maybe [SuggestionHighlight]
a} :: SuggestionTextWithHighlights) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The query suggestion text to display to the user.
suggestionTextWithHighlights_text :: Lens.Lens' SuggestionTextWithHighlights (Prelude.Maybe Prelude.Text)
suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text)
suggestionTextWithHighlights_text = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuggestionTextWithHighlights' {Maybe Text
text :: Maybe Text
$sel:text:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe Text
text} -> Maybe Text
text) (\s :: SuggestionTextWithHighlights
s@SuggestionTextWithHighlights' {} Maybe Text
a -> SuggestionTextWithHighlights
s {$sel:text:SuggestionTextWithHighlights' :: Maybe Text
text = Maybe Text
a} :: SuggestionTextWithHighlights)

instance Data.FromJSON SuggestionTextWithHighlights where
  parseJSON :: Value -> Parser SuggestionTextWithHighlights
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SuggestionTextWithHighlights"
      ( \Object
x ->
          Maybe [SuggestionHighlight]
-> Maybe Text -> SuggestionTextWithHighlights
SuggestionTextWithHighlights'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Highlights" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Text")
      )

instance
  Prelude.Hashable
    SuggestionTextWithHighlights
  where
  hashWithSalt :: Int -> SuggestionTextWithHighlights -> Int
hashWithSalt Int
_salt SuggestionTextWithHighlights' {Maybe [SuggestionHighlight]
Maybe Text
text :: Maybe Text
highlights :: Maybe [SuggestionHighlight]
$sel:text:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe Text
$sel:highlights:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe [SuggestionHighlight]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [SuggestionHighlight]
highlights
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
text

instance Prelude.NFData SuggestionTextWithHighlights where
  rnf :: SuggestionTextWithHighlights -> ()
rnf SuggestionTextWithHighlights' {Maybe [SuggestionHighlight]
Maybe Text
text :: Maybe Text
highlights :: Maybe [SuggestionHighlight]
$sel:text:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe Text
$sel:highlights:SuggestionTextWithHighlights' :: SuggestionTextWithHighlights -> Maybe [SuggestionHighlight]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [SuggestionHighlight]
highlights
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
text