{-# 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.BatchDetectSentimentItemResult
-- 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.BatchDetectSentimentItemResult where

import Amazonka.Comprehend.Types.SentimentScore
import Amazonka.Comprehend.Types.SentimentType
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

-- | The result of calling the operation. The operation returns one object
-- for each document that is successfully processed by the operation.
--
-- /See:/ 'newBatchDetectSentimentItemResult' smart constructor.
data BatchDetectSentimentItemResult = BatchDetectSentimentItemResult'
  { -- | The zero-based index of the document in the input list.
    BatchDetectSentimentItemResult -> Maybe Int
index :: Prelude.Maybe Prelude.Int,
    -- | The sentiment detected in the document.
    BatchDetectSentimentItemResult -> Maybe SentimentType
sentiment :: Prelude.Maybe SentimentType,
    -- | The level of confidence that Amazon Comprehend has in the accuracy of
    -- its sentiment detection.
    BatchDetectSentimentItemResult -> Maybe SentimentScore
sentimentScore :: Prelude.Maybe SentimentScore
  }
  deriving (BatchDetectSentimentItemResult
-> BatchDetectSentimentItemResult -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BatchDetectSentimentItemResult
-> BatchDetectSentimentItemResult -> Bool
$c/= :: BatchDetectSentimentItemResult
-> BatchDetectSentimentItemResult -> Bool
== :: BatchDetectSentimentItemResult
-> BatchDetectSentimentItemResult -> Bool
$c== :: BatchDetectSentimentItemResult
-> BatchDetectSentimentItemResult -> Bool
Prelude.Eq, ReadPrec [BatchDetectSentimentItemResult]
ReadPrec BatchDetectSentimentItemResult
Int -> ReadS BatchDetectSentimentItemResult
ReadS [BatchDetectSentimentItemResult]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BatchDetectSentimentItemResult]
$creadListPrec :: ReadPrec [BatchDetectSentimentItemResult]
readPrec :: ReadPrec BatchDetectSentimentItemResult
$creadPrec :: ReadPrec BatchDetectSentimentItemResult
readList :: ReadS [BatchDetectSentimentItemResult]
$creadList :: ReadS [BatchDetectSentimentItemResult]
readsPrec :: Int -> ReadS BatchDetectSentimentItemResult
$creadsPrec :: Int -> ReadS BatchDetectSentimentItemResult
Prelude.Read, Int -> BatchDetectSentimentItemResult -> ShowS
[BatchDetectSentimentItemResult] -> ShowS
BatchDetectSentimentItemResult -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BatchDetectSentimentItemResult] -> ShowS
$cshowList :: [BatchDetectSentimentItemResult] -> ShowS
show :: BatchDetectSentimentItemResult -> String
$cshow :: BatchDetectSentimentItemResult -> String
showsPrec :: Int -> BatchDetectSentimentItemResult -> ShowS
$cshowsPrec :: Int -> BatchDetectSentimentItemResult -> ShowS
Prelude.Show, forall x.
Rep BatchDetectSentimentItemResult x
-> BatchDetectSentimentItemResult
forall x.
BatchDetectSentimentItemResult
-> Rep BatchDetectSentimentItemResult x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep BatchDetectSentimentItemResult x
-> BatchDetectSentimentItemResult
$cfrom :: forall x.
BatchDetectSentimentItemResult
-> Rep BatchDetectSentimentItemResult x
Prelude.Generic)

-- |
-- Create a value of 'BatchDetectSentimentItemResult' 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:
--
-- 'index', 'batchDetectSentimentItemResult_index' - The zero-based index of the document in the input list.
--
-- 'sentiment', 'batchDetectSentimentItemResult_sentiment' - The sentiment detected in the document.
--
-- 'sentimentScore', 'batchDetectSentimentItemResult_sentimentScore' - The level of confidence that Amazon Comprehend has in the accuracy of
-- its sentiment detection.
newBatchDetectSentimentItemResult ::
  BatchDetectSentimentItemResult
newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult
newBatchDetectSentimentItemResult =
  BatchDetectSentimentItemResult'
    { $sel:index:BatchDetectSentimentItemResult' :: Maybe Int
index =
        forall a. Maybe a
Prelude.Nothing,
      $sel:sentiment:BatchDetectSentimentItemResult' :: Maybe SentimentType
sentiment = forall a. Maybe a
Prelude.Nothing,
      $sel:sentimentScore:BatchDetectSentimentItemResult' :: Maybe SentimentScore
sentimentScore = forall a. Maybe a
Prelude.Nothing
    }

-- | The zero-based index of the document in the input list.
batchDetectSentimentItemResult_index :: Lens.Lens' BatchDetectSentimentItemResult (Prelude.Maybe Prelude.Int)
batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int)
batchDetectSentimentItemResult_index = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchDetectSentimentItemResult' {Maybe Int
index :: Maybe Int
$sel:index:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe Int
index} -> Maybe Int
index) (\s :: BatchDetectSentimentItemResult
s@BatchDetectSentimentItemResult' {} Maybe Int
a -> BatchDetectSentimentItemResult
s {$sel:index:BatchDetectSentimentItemResult' :: Maybe Int
index = Maybe Int
a} :: BatchDetectSentimentItemResult)

-- | The sentiment detected in the document.
batchDetectSentimentItemResult_sentiment :: Lens.Lens' BatchDetectSentimentItemResult (Prelude.Maybe SentimentType)
batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType)
batchDetectSentimentItemResult_sentiment = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchDetectSentimentItemResult' {Maybe SentimentType
sentiment :: Maybe SentimentType
$sel:sentiment:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentType
sentiment} -> Maybe SentimentType
sentiment) (\s :: BatchDetectSentimentItemResult
s@BatchDetectSentimentItemResult' {} Maybe SentimentType
a -> BatchDetectSentimentItemResult
s {$sel:sentiment:BatchDetectSentimentItemResult' :: Maybe SentimentType
sentiment = Maybe SentimentType
a} :: BatchDetectSentimentItemResult)

-- | The level of confidence that Amazon Comprehend has in the accuracy of
-- its sentiment detection.
batchDetectSentimentItemResult_sentimentScore :: Lens.Lens' BatchDetectSentimentItemResult (Prelude.Maybe SentimentScore)
batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore)
batchDetectSentimentItemResult_sentimentScore = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchDetectSentimentItemResult' {Maybe SentimentScore
sentimentScore :: Maybe SentimentScore
$sel:sentimentScore:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentScore
sentimentScore} -> Maybe SentimentScore
sentimentScore) (\s :: BatchDetectSentimentItemResult
s@BatchDetectSentimentItemResult' {} Maybe SentimentScore
a -> BatchDetectSentimentItemResult
s {$sel:sentimentScore:BatchDetectSentimentItemResult' :: Maybe SentimentScore
sentimentScore = Maybe SentimentScore
a} :: BatchDetectSentimentItemResult)

instance Data.FromJSON BatchDetectSentimentItemResult where
  parseJSON :: Value -> Parser BatchDetectSentimentItemResult
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"BatchDetectSentimentItemResult"
      ( \Object
x ->
          Maybe Int
-> Maybe SentimentType
-> Maybe SentimentScore
-> BatchDetectSentimentItemResult
BatchDetectSentimentItemResult'
            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
"Index")
            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
"Sentiment")
            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
"SentimentScore")
      )

instance
  Prelude.Hashable
    BatchDetectSentimentItemResult
  where
  hashWithSalt :: Int -> BatchDetectSentimentItemResult -> Int
hashWithSalt
    Int
_salt
    BatchDetectSentimentItemResult' {Maybe Int
Maybe SentimentScore
Maybe SentimentType
sentimentScore :: Maybe SentimentScore
sentiment :: Maybe SentimentType
index :: Maybe Int
$sel:sentimentScore:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentScore
$sel:sentiment:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentType
$sel:index:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe Int
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
index
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SentimentType
sentiment
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SentimentScore
sentimentScore

instance
  Prelude.NFData
    BatchDetectSentimentItemResult
  where
  rnf :: BatchDetectSentimentItemResult -> ()
rnf BatchDetectSentimentItemResult' {Maybe Int
Maybe SentimentScore
Maybe SentimentType
sentimentScore :: Maybe SentimentScore
sentiment :: Maybe SentimentType
index :: Maybe Int
$sel:sentimentScore:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentScore
$sel:sentiment:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe SentimentType
$sel:index:BatchDetectSentimentItemResult' :: BatchDetectSentimentItemResult -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
index
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SentimentType
sentiment
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SentimentScore
sentimentScore