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

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

-- | Specifies one of the label or labels that categorize the personally
-- identifiable information (PII) entity being analyzed.
--
-- /See:/ 'newEntityLabel' smart constructor.
data EntityLabel = EntityLabel'
  { -- | The name of the label.
    EntityLabel -> Maybe PiiEntityType
name :: Prelude.Maybe PiiEntityType,
    -- | The level of confidence that Amazon Comprehend has in the accuracy of
    -- the detection.
    EntityLabel -> Maybe Double
score :: Prelude.Maybe Prelude.Double
  }
  deriving (EntityLabel -> EntityLabel -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntityLabel -> EntityLabel -> Bool
$c/= :: EntityLabel -> EntityLabel -> Bool
== :: EntityLabel -> EntityLabel -> Bool
$c== :: EntityLabel -> EntityLabel -> Bool
Prelude.Eq, ReadPrec [EntityLabel]
ReadPrec EntityLabel
Int -> ReadS EntityLabel
ReadS [EntityLabel]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntityLabel]
$creadListPrec :: ReadPrec [EntityLabel]
readPrec :: ReadPrec EntityLabel
$creadPrec :: ReadPrec EntityLabel
readList :: ReadS [EntityLabel]
$creadList :: ReadS [EntityLabel]
readsPrec :: Int -> ReadS EntityLabel
$creadsPrec :: Int -> ReadS EntityLabel
Prelude.Read, Int -> EntityLabel -> ShowS
[EntityLabel] -> ShowS
EntityLabel -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntityLabel] -> ShowS
$cshowList :: [EntityLabel] -> ShowS
show :: EntityLabel -> String
$cshow :: EntityLabel -> String
showsPrec :: Int -> EntityLabel -> ShowS
$cshowsPrec :: Int -> EntityLabel -> ShowS
Prelude.Show, forall x. Rep EntityLabel x -> EntityLabel
forall x. EntityLabel -> Rep EntityLabel x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EntityLabel x -> EntityLabel
$cfrom :: forall x. EntityLabel -> Rep EntityLabel x
Prelude.Generic)

-- |
-- Create a value of 'EntityLabel' 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:
--
-- 'name', 'entityLabel_name' - The name of the label.
--
-- 'score', 'entityLabel_score' - The level of confidence that Amazon Comprehend has in the accuracy of
-- the detection.
newEntityLabel ::
  EntityLabel
newEntityLabel :: EntityLabel
newEntityLabel =
  EntityLabel'
    { $sel:name:EntityLabel' :: Maybe PiiEntityType
name = forall a. Maybe a
Prelude.Nothing,
      $sel:score:EntityLabel' :: Maybe Double
score = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the label.
entityLabel_name :: Lens.Lens' EntityLabel (Prelude.Maybe PiiEntityType)
entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType)
entityLabel_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityLabel' {Maybe PiiEntityType
name :: Maybe PiiEntityType
$sel:name:EntityLabel' :: EntityLabel -> Maybe PiiEntityType
name} -> Maybe PiiEntityType
name) (\s :: EntityLabel
s@EntityLabel' {} Maybe PiiEntityType
a -> EntityLabel
s {$sel:name:EntityLabel' :: Maybe PiiEntityType
name = Maybe PiiEntityType
a} :: EntityLabel)

-- | The level of confidence that Amazon Comprehend has in the accuracy of
-- the detection.
entityLabel_score :: Lens.Lens' EntityLabel (Prelude.Maybe Prelude.Double)
entityLabel_score :: Lens' EntityLabel (Maybe Double)
entityLabel_score = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityLabel' {Maybe Double
score :: Maybe Double
$sel:score:EntityLabel' :: EntityLabel -> Maybe Double
score} -> Maybe Double
score) (\s :: EntityLabel
s@EntityLabel' {} Maybe Double
a -> EntityLabel
s {$sel:score:EntityLabel' :: Maybe Double
score = Maybe Double
a} :: EntityLabel)

instance Data.FromJSON EntityLabel where
  parseJSON :: Value -> Parser EntityLabel
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EntityLabel"
      ( \Object
x ->
          Maybe PiiEntityType -> Maybe Double -> EntityLabel
EntityLabel'
            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
"Name")
            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
"Score")
      )

instance Prelude.Hashable EntityLabel where
  hashWithSalt :: Int -> EntityLabel -> Int
hashWithSalt Int
_salt EntityLabel' {Maybe Double
Maybe PiiEntityType
score :: Maybe Double
name :: Maybe PiiEntityType
$sel:score:EntityLabel' :: EntityLabel -> Maybe Double
$sel:name:EntityLabel' :: EntityLabel -> Maybe PiiEntityType
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PiiEntityType
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
score

instance Prelude.NFData EntityLabel where
  rnf :: EntityLabel -> ()
rnf EntityLabel' {Maybe Double
Maybe PiiEntityType
score :: Maybe Double
name :: Maybe PiiEntityType
$sel:score:EntityLabel' :: EntityLabel -> Maybe Double
$sel:name:EntityLabel' :: EntityLabel -> Maybe PiiEntityType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe PiiEntityType
name seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
score