{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# 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.DetectTargetedSentiment
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Inspects the input text and returns a sentiment analysis for each entity
-- identified in the text.
--
-- For more information about targeted sentiment, see
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html Targeted sentiment>.
module Amazonka.Comprehend.DetectTargetedSentiment
  ( -- * Creating a Request
    DetectTargetedSentiment (..),
    newDetectTargetedSentiment,

    -- * Request Lenses
    detectTargetedSentiment_text,
    detectTargetedSentiment_languageCode,

    -- * Destructuring the Response
    DetectTargetedSentimentResponse (..),
    newDetectTargetedSentimentResponse,

    -- * Response Lenses
    detectTargetedSentimentResponse_entities,
    detectTargetedSentimentResponse_httpStatus,
  )
where

import Amazonka.Comprehend.Types
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
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDetectTargetedSentiment' smart constructor.
data DetectTargetedSentiment = DetectTargetedSentiment'
  { -- | A UTF-8 text string. The maximum string length is 5 KB.
    DetectTargetedSentiment -> Sensitive Text
text :: Data.Sensitive Prelude.Text,
    -- | The language of the input documents. Currently, English is the only
    -- supported language.
    DetectTargetedSentiment -> LanguageCode
languageCode :: LanguageCode
  }
  deriving (DetectTargetedSentiment -> DetectTargetedSentiment -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DetectTargetedSentiment -> DetectTargetedSentiment -> Bool
$c/= :: DetectTargetedSentiment -> DetectTargetedSentiment -> Bool
== :: DetectTargetedSentiment -> DetectTargetedSentiment -> Bool
$c== :: DetectTargetedSentiment -> DetectTargetedSentiment -> Bool
Prelude.Eq, Int -> DetectTargetedSentiment -> ShowS
[DetectTargetedSentiment] -> ShowS
DetectTargetedSentiment -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DetectTargetedSentiment] -> ShowS
$cshowList :: [DetectTargetedSentiment] -> ShowS
show :: DetectTargetedSentiment -> String
$cshow :: DetectTargetedSentiment -> String
showsPrec :: Int -> DetectTargetedSentiment -> ShowS
$cshowsPrec :: Int -> DetectTargetedSentiment -> ShowS
Prelude.Show, forall x. Rep DetectTargetedSentiment x -> DetectTargetedSentiment
forall x. DetectTargetedSentiment -> Rep DetectTargetedSentiment x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DetectTargetedSentiment x -> DetectTargetedSentiment
$cfrom :: forall x. DetectTargetedSentiment -> Rep DetectTargetedSentiment x
Prelude.Generic)

-- |
-- Create a value of 'DetectTargetedSentiment' 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:
--
-- 'text', 'detectTargetedSentiment_text' - A UTF-8 text string. The maximum string length is 5 KB.
--
-- 'languageCode', 'detectTargetedSentiment_languageCode' - The language of the input documents. Currently, English is the only
-- supported language.
newDetectTargetedSentiment ::
  -- | 'text'
  Prelude.Text ->
  -- | 'languageCode'
  LanguageCode ->
  DetectTargetedSentiment
newDetectTargetedSentiment :: Text -> LanguageCode -> DetectTargetedSentiment
newDetectTargetedSentiment Text
pText_ LanguageCode
pLanguageCode_ =
  DetectTargetedSentiment'
    { $sel:text:DetectTargetedSentiment' :: Sensitive Text
text =
        forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pText_,
      $sel:languageCode:DetectTargetedSentiment' :: LanguageCode
languageCode = LanguageCode
pLanguageCode_
    }

-- | A UTF-8 text string. The maximum string length is 5 KB.
detectTargetedSentiment_text :: Lens.Lens' DetectTargetedSentiment Prelude.Text
detectTargetedSentiment_text :: Lens' DetectTargetedSentiment Text
detectTargetedSentiment_text = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTargetedSentiment' {Sensitive Text
text :: Sensitive Text
$sel:text:DetectTargetedSentiment' :: DetectTargetedSentiment -> Sensitive Text
text} -> Sensitive Text
text) (\s :: DetectTargetedSentiment
s@DetectTargetedSentiment' {} Sensitive Text
a -> DetectTargetedSentiment
s {$sel:text:DetectTargetedSentiment' :: Sensitive Text
text = Sensitive Text
a} :: DetectTargetedSentiment) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The language of the input documents. Currently, English is the only
-- supported language.
detectTargetedSentiment_languageCode :: Lens.Lens' DetectTargetedSentiment LanguageCode
detectTargetedSentiment_languageCode :: Lens' DetectTargetedSentiment LanguageCode
detectTargetedSentiment_languageCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTargetedSentiment' {LanguageCode
languageCode :: LanguageCode
$sel:languageCode:DetectTargetedSentiment' :: DetectTargetedSentiment -> LanguageCode
languageCode} -> LanguageCode
languageCode) (\s :: DetectTargetedSentiment
s@DetectTargetedSentiment' {} LanguageCode
a -> DetectTargetedSentiment
s {$sel:languageCode:DetectTargetedSentiment' :: LanguageCode
languageCode = LanguageCode
a} :: DetectTargetedSentiment)

instance Core.AWSRequest DetectTargetedSentiment where
  type
    AWSResponse DetectTargetedSentiment =
      DetectTargetedSentimentResponse
  request :: (Service -> Service)
-> DetectTargetedSentiment -> Request DetectTargetedSentiment
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DetectTargetedSentiment
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DetectTargetedSentiment)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [TargetedSentimentEntity]
-> Int -> DetectTargetedSentimentResponse
DetectTargetedSentimentResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Entities" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DetectTargetedSentiment where
  hashWithSalt :: Int -> DetectTargetedSentiment -> Int
hashWithSalt Int
_salt DetectTargetedSentiment' {Sensitive Text
LanguageCode
languageCode :: LanguageCode
text :: Sensitive Text
$sel:languageCode:DetectTargetedSentiment' :: DetectTargetedSentiment -> LanguageCode
$sel:text:DetectTargetedSentiment' :: DetectTargetedSentiment -> Sensitive Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
text
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` LanguageCode
languageCode

instance Prelude.NFData DetectTargetedSentiment where
  rnf :: DetectTargetedSentiment -> ()
rnf DetectTargetedSentiment' {Sensitive Text
LanguageCode
languageCode :: LanguageCode
text :: Sensitive Text
$sel:languageCode:DetectTargetedSentiment' :: DetectTargetedSentiment -> LanguageCode
$sel:text:DetectTargetedSentiment' :: DetectTargetedSentiment -> Sensitive Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
text
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf LanguageCode
languageCode

instance Data.ToHeaders DetectTargetedSentiment where
  toHeaders :: DetectTargetedSentiment -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"Comprehend_20171127.DetectTargetedSentiment" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DetectTargetedSentiment where
  toJSON :: DetectTargetedSentiment -> Value
toJSON DetectTargetedSentiment' {Sensitive Text
LanguageCode
languageCode :: LanguageCode
text :: Sensitive Text
$sel:languageCode:DetectTargetedSentiment' :: DetectTargetedSentiment -> LanguageCode
$sel:text:DetectTargetedSentiment' :: DetectTargetedSentiment -> Sensitive Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Text" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
text),
            forall a. a -> Maybe a
Prelude.Just (Key
"LanguageCode" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= LanguageCode
languageCode)
          ]
      )

instance Data.ToPath DetectTargetedSentiment where
  toPath :: DetectTargetedSentiment -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery DetectTargetedSentiment where
  toQuery :: DetectTargetedSentiment -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDetectTargetedSentimentResponse' smart constructor.
data DetectTargetedSentimentResponse = DetectTargetedSentimentResponse'
  { -- | Targeted sentiment analysis for each of the entities identified in the
    -- input text.
    DetectTargetedSentimentResponse -> Maybe [TargetedSentimentEntity]
entities :: Prelude.Maybe [TargetedSentimentEntity],
    -- | The response's http status code.
    DetectTargetedSentimentResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DetectTargetedSentimentResponse
-> DetectTargetedSentimentResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DetectTargetedSentimentResponse
-> DetectTargetedSentimentResponse -> Bool
$c/= :: DetectTargetedSentimentResponse
-> DetectTargetedSentimentResponse -> Bool
== :: DetectTargetedSentimentResponse
-> DetectTargetedSentimentResponse -> Bool
$c== :: DetectTargetedSentimentResponse
-> DetectTargetedSentimentResponse -> Bool
Prelude.Eq, Int -> DetectTargetedSentimentResponse -> ShowS
[DetectTargetedSentimentResponse] -> ShowS
DetectTargetedSentimentResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DetectTargetedSentimentResponse] -> ShowS
$cshowList :: [DetectTargetedSentimentResponse] -> ShowS
show :: DetectTargetedSentimentResponse -> String
$cshow :: DetectTargetedSentimentResponse -> String
showsPrec :: Int -> DetectTargetedSentimentResponse -> ShowS
$cshowsPrec :: Int -> DetectTargetedSentimentResponse -> ShowS
Prelude.Show, forall x.
Rep DetectTargetedSentimentResponse x
-> DetectTargetedSentimentResponse
forall x.
DetectTargetedSentimentResponse
-> Rep DetectTargetedSentimentResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DetectTargetedSentimentResponse x
-> DetectTargetedSentimentResponse
$cfrom :: forall x.
DetectTargetedSentimentResponse
-> Rep DetectTargetedSentimentResponse x
Prelude.Generic)

-- |
-- Create a value of 'DetectTargetedSentimentResponse' 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:
--
-- 'entities', 'detectTargetedSentimentResponse_entities' - Targeted sentiment analysis for each of the entities identified in the
-- input text.
--
-- 'httpStatus', 'detectTargetedSentimentResponse_httpStatus' - The response's http status code.
newDetectTargetedSentimentResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DetectTargetedSentimentResponse
newDetectTargetedSentimentResponse :: Int -> DetectTargetedSentimentResponse
newDetectTargetedSentimentResponse Int
pHttpStatus_ =
  DetectTargetedSentimentResponse'
    { $sel:entities:DetectTargetedSentimentResponse' :: Maybe [TargetedSentimentEntity]
entities =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DetectTargetedSentimentResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Targeted sentiment analysis for each of the entities identified in the
-- input text.
detectTargetedSentimentResponse_entities :: Lens.Lens' DetectTargetedSentimentResponse (Prelude.Maybe [TargetedSentimentEntity])
detectTargetedSentimentResponse_entities :: Lens'
  DetectTargetedSentimentResponse (Maybe [TargetedSentimentEntity])
detectTargetedSentimentResponse_entities = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTargetedSentimentResponse' {Maybe [TargetedSentimentEntity]
entities :: Maybe [TargetedSentimentEntity]
$sel:entities:DetectTargetedSentimentResponse' :: DetectTargetedSentimentResponse -> Maybe [TargetedSentimentEntity]
entities} -> Maybe [TargetedSentimentEntity]
entities) (\s :: DetectTargetedSentimentResponse
s@DetectTargetedSentimentResponse' {} Maybe [TargetedSentimentEntity]
a -> DetectTargetedSentimentResponse
s {$sel:entities:DetectTargetedSentimentResponse' :: Maybe [TargetedSentimentEntity]
entities = Maybe [TargetedSentimentEntity]
a} :: DetectTargetedSentimentResponse) 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 response's http status code.
detectTargetedSentimentResponse_httpStatus :: Lens.Lens' DetectTargetedSentimentResponse Prelude.Int
detectTargetedSentimentResponse_httpStatus :: Lens' DetectTargetedSentimentResponse Int
detectTargetedSentimentResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DetectTargetedSentimentResponse' {Int
httpStatus :: Int
$sel:httpStatus:DetectTargetedSentimentResponse' :: DetectTargetedSentimentResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DetectTargetedSentimentResponse
s@DetectTargetedSentimentResponse' {} Int
a -> DetectTargetedSentimentResponse
s {$sel:httpStatus:DetectTargetedSentimentResponse' :: Int
httpStatus = Int
a} :: DetectTargetedSentimentResponse)

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