{-# 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.Comprehend.Types.TargetedSentimentEntity
-- 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.Comprehend.Types.TargetedSentimentEntity where

import Amazonka.Comprehend.Types.TargetedSentimentMention
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Information about one of the entities found by targeted sentiment
-- analysis.
--
-- For more information about targeted sentiment, see
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html Targeted sentiment>.
--
-- /See:/ 'newTargetedSentimentEntity' smart constructor.
data TargetedSentimentEntity = TargetedSentimentEntity'
  { -- | One or more index into the Mentions array that provides the best name
    -- for the entity group.
    TargetedSentimentEntity -> Maybe [Int]
descriptiveMentionIndex :: Prelude.Maybe [Prelude.Int],
    -- | An array of mentions of the entity in the document. The array represents
    -- a co-reference group. See
    -- <https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values Co-reference group>
    -- for an example.
    TargetedSentimentEntity -> Maybe [TargetedSentimentMention]
mentions :: Prelude.Maybe [TargetedSentimentMention]
  }
  deriving (TargetedSentimentEntity -> TargetedSentimentEntity -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TargetedSentimentEntity -> TargetedSentimentEntity -> Bool
$c/= :: TargetedSentimentEntity -> TargetedSentimentEntity -> Bool
== :: TargetedSentimentEntity -> TargetedSentimentEntity -> Bool
$c== :: TargetedSentimentEntity -> TargetedSentimentEntity -> Bool
Prelude.Eq, ReadPrec [TargetedSentimentEntity]
ReadPrec TargetedSentimentEntity
Int -> ReadS TargetedSentimentEntity
ReadS [TargetedSentimentEntity]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TargetedSentimentEntity]
$creadListPrec :: ReadPrec [TargetedSentimentEntity]
readPrec :: ReadPrec TargetedSentimentEntity
$creadPrec :: ReadPrec TargetedSentimentEntity
readList :: ReadS [TargetedSentimentEntity]
$creadList :: ReadS [TargetedSentimentEntity]
readsPrec :: Int -> ReadS TargetedSentimentEntity
$creadsPrec :: Int -> ReadS TargetedSentimentEntity
Prelude.Read, Int -> TargetedSentimentEntity -> ShowS
[TargetedSentimentEntity] -> ShowS
TargetedSentimentEntity -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TargetedSentimentEntity] -> ShowS
$cshowList :: [TargetedSentimentEntity] -> ShowS
show :: TargetedSentimentEntity -> String
$cshow :: TargetedSentimentEntity -> String
showsPrec :: Int -> TargetedSentimentEntity -> ShowS
$cshowsPrec :: Int -> TargetedSentimentEntity -> ShowS
Prelude.Show, forall x. Rep TargetedSentimentEntity x -> TargetedSentimentEntity
forall x. TargetedSentimentEntity -> Rep TargetedSentimentEntity x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TargetedSentimentEntity x -> TargetedSentimentEntity
$cfrom :: forall x. TargetedSentimentEntity -> Rep TargetedSentimentEntity x
Prelude.Generic)

-- |
-- Create a value of 'TargetedSentimentEntity' 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:
--
-- 'descriptiveMentionIndex', 'targetedSentimentEntity_descriptiveMentionIndex' - One or more index into the Mentions array that provides the best name
-- for the entity group.
--
-- 'mentions', 'targetedSentimentEntity_mentions' - An array of mentions of the entity in the document. The array represents
-- a co-reference group. See
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values Co-reference group>
-- for an example.
newTargetedSentimentEntity ::
  TargetedSentimentEntity
newTargetedSentimentEntity :: TargetedSentimentEntity
newTargetedSentimentEntity =
  TargetedSentimentEntity'
    { $sel:descriptiveMentionIndex:TargetedSentimentEntity' :: Maybe [Int]
descriptiveMentionIndex =
        forall a. Maybe a
Prelude.Nothing,
      $sel:mentions:TargetedSentimentEntity' :: Maybe [TargetedSentimentMention]
mentions = forall a. Maybe a
Prelude.Nothing
    }

-- | One or more index into the Mentions array that provides the best name
-- for the entity group.
targetedSentimentEntity_descriptiveMentionIndex :: Lens.Lens' TargetedSentimentEntity (Prelude.Maybe [Prelude.Int])
targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int])
targetedSentimentEntity_descriptiveMentionIndex = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetedSentimentEntity' {Maybe [Int]
descriptiveMentionIndex :: Maybe [Int]
$sel:descriptiveMentionIndex:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [Int]
descriptiveMentionIndex} -> Maybe [Int]
descriptiveMentionIndex) (\s :: TargetedSentimentEntity
s@TargetedSentimentEntity' {} Maybe [Int]
a -> TargetedSentimentEntity
s {$sel:descriptiveMentionIndex:TargetedSentimentEntity' :: Maybe [Int]
descriptiveMentionIndex = Maybe [Int]
a} :: TargetedSentimentEntity) 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

-- | An array of mentions of the entity in the document. The array represents
-- a co-reference group. See
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values Co-reference group>
-- for an example.
targetedSentimentEntity_mentions :: Lens.Lens' TargetedSentimentEntity (Prelude.Maybe [TargetedSentimentMention])
targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention])
targetedSentimentEntity_mentions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetedSentimentEntity' {Maybe [TargetedSentimentMention]
mentions :: Maybe [TargetedSentimentMention]
$sel:mentions:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [TargetedSentimentMention]
mentions} -> Maybe [TargetedSentimentMention]
mentions) (\s :: TargetedSentimentEntity
s@TargetedSentimentEntity' {} Maybe [TargetedSentimentMention]
a -> TargetedSentimentEntity
s {$sel:mentions:TargetedSentimentEntity' :: Maybe [TargetedSentimentMention]
mentions = Maybe [TargetedSentimentMention]
a} :: TargetedSentimentEntity) 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

instance Data.FromJSON TargetedSentimentEntity where
  parseJSON :: Value -> Parser TargetedSentimentEntity
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TargetedSentimentEntity"
      ( \Object
x ->
          Maybe [Int]
-> Maybe [TargetedSentimentMention] -> TargetedSentimentEntity
TargetedSentimentEntity'
            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
"DescriptiveMentionIndex"
                            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
"Mentions" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable TargetedSentimentEntity where
  hashWithSalt :: Int -> TargetedSentimentEntity -> Int
hashWithSalt Int
_salt TargetedSentimentEntity' {Maybe [Int]
Maybe [TargetedSentimentMention]
mentions :: Maybe [TargetedSentimentMention]
descriptiveMentionIndex :: Maybe [Int]
$sel:mentions:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [TargetedSentimentMention]
$sel:descriptiveMentionIndex:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [Int]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Int]
descriptiveMentionIndex
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [TargetedSentimentMention]
mentions

instance Prelude.NFData TargetedSentimentEntity where
  rnf :: TargetedSentimentEntity -> ()
rnf TargetedSentimentEntity' {Maybe [Int]
Maybe [TargetedSentimentMention]
mentions :: Maybe [TargetedSentimentMention]
descriptiveMentionIndex :: Maybe [Int]
$sel:mentions:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [TargetedSentimentMention]
$sel:descriptiveMentionIndex:TargetedSentimentEntity' :: TargetedSentimentEntity -> Maybe [Int]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Int]
descriptiveMentionIndex
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [TargetedSentimentMention]
mentions