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

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

-- | Individual item from the list of entity types in the metadata of an
-- entity recognizer.
--
-- /See:/ 'newEntityRecognizerMetadataEntityTypesListItem' smart constructor.
data EntityRecognizerMetadataEntityTypesListItem = EntityRecognizerMetadataEntityTypesListItem'
  { -- | Detailed information about the accuracy of the entity recognizer for a
    -- specific item on the list of entity types.
    EntityRecognizerMetadataEntityTypesListItem
-> Maybe EntityTypesEvaluationMetrics
evaluationMetrics :: Prelude.Maybe EntityTypesEvaluationMetrics,
    -- | Indicates the number of times the given entity type was seen in the
    -- training data.
    EntityRecognizerMetadataEntityTypesListItem -> Maybe Int
numberOfTrainMentions :: Prelude.Maybe Prelude.Int,
    -- | Type of entity from the list of entity types in the metadata of an
    -- entity recognizer.
    EntityRecognizerMetadataEntityTypesListItem -> Maybe Text
type' :: Prelude.Maybe Prelude.Text
  }
  deriving (EntityRecognizerMetadataEntityTypesListItem
-> EntityRecognizerMetadataEntityTypesListItem -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntityRecognizerMetadataEntityTypesListItem
-> EntityRecognizerMetadataEntityTypesListItem -> Bool
$c/= :: EntityRecognizerMetadataEntityTypesListItem
-> EntityRecognizerMetadataEntityTypesListItem -> Bool
== :: EntityRecognizerMetadataEntityTypesListItem
-> EntityRecognizerMetadataEntityTypesListItem -> Bool
$c== :: EntityRecognizerMetadataEntityTypesListItem
-> EntityRecognizerMetadataEntityTypesListItem -> Bool
Prelude.Eq, ReadPrec [EntityRecognizerMetadataEntityTypesListItem]
ReadPrec EntityRecognizerMetadataEntityTypesListItem
Int -> ReadS EntityRecognizerMetadataEntityTypesListItem
ReadS [EntityRecognizerMetadataEntityTypesListItem]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntityRecognizerMetadataEntityTypesListItem]
$creadListPrec :: ReadPrec [EntityRecognizerMetadataEntityTypesListItem]
readPrec :: ReadPrec EntityRecognizerMetadataEntityTypesListItem
$creadPrec :: ReadPrec EntityRecognizerMetadataEntityTypesListItem
readList :: ReadS [EntityRecognizerMetadataEntityTypesListItem]
$creadList :: ReadS [EntityRecognizerMetadataEntityTypesListItem]
readsPrec :: Int -> ReadS EntityRecognizerMetadataEntityTypesListItem
$creadsPrec :: Int -> ReadS EntityRecognizerMetadataEntityTypesListItem
Prelude.Read, Int -> EntityRecognizerMetadataEntityTypesListItem -> ShowS
[EntityRecognizerMetadataEntityTypesListItem] -> ShowS
EntityRecognizerMetadataEntityTypesListItem -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntityRecognizerMetadataEntityTypesListItem] -> ShowS
$cshowList :: [EntityRecognizerMetadataEntityTypesListItem] -> ShowS
show :: EntityRecognizerMetadataEntityTypesListItem -> String
$cshow :: EntityRecognizerMetadataEntityTypesListItem -> String
showsPrec :: Int -> EntityRecognizerMetadataEntityTypesListItem -> ShowS
$cshowsPrec :: Int -> EntityRecognizerMetadataEntityTypesListItem -> ShowS
Prelude.Show, forall x.
Rep EntityRecognizerMetadataEntityTypesListItem x
-> EntityRecognizerMetadataEntityTypesListItem
forall x.
EntityRecognizerMetadataEntityTypesListItem
-> Rep EntityRecognizerMetadataEntityTypesListItem x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep EntityRecognizerMetadataEntityTypesListItem x
-> EntityRecognizerMetadataEntityTypesListItem
$cfrom :: forall x.
EntityRecognizerMetadataEntityTypesListItem
-> Rep EntityRecognizerMetadataEntityTypesListItem x
Prelude.Generic)

-- |
-- Create a value of 'EntityRecognizerMetadataEntityTypesListItem' 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:
--
-- 'evaluationMetrics', 'entityRecognizerMetadataEntityTypesListItem_evaluationMetrics' - Detailed information about the accuracy of the entity recognizer for a
-- specific item on the list of entity types.
--
-- 'numberOfTrainMentions', 'entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions' - Indicates the number of times the given entity type was seen in the
-- training data.
--
-- 'type'', 'entityRecognizerMetadataEntityTypesListItem_type' - Type of entity from the list of entity types in the metadata of an
-- entity recognizer.
newEntityRecognizerMetadataEntityTypesListItem ::
  EntityRecognizerMetadataEntityTypesListItem
newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem
newEntityRecognizerMetadataEntityTypesListItem =
  EntityRecognizerMetadataEntityTypesListItem'
    { $sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem' :: Maybe EntityTypesEvaluationMetrics
evaluationMetrics =
        forall a. Maybe a
Prelude.Nothing,
      $sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem' :: Maybe Int
numberOfTrainMentions =
        forall a. Maybe a
Prelude.Nothing,
      $sel:type':EntityRecognizerMetadataEntityTypesListItem' :: Maybe Text
type' = forall a. Maybe a
Prelude.Nothing
    }

-- | Detailed information about the accuracy of the entity recognizer for a
-- specific item on the list of entity types.
entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens.Lens' EntityRecognizerMetadataEntityTypesListItem (Prelude.Maybe EntityTypesEvaluationMetrics)
entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens'
  EntityRecognizerMetadataEntityTypesListItem
  (Maybe EntityTypesEvaluationMetrics)
entityRecognizerMetadataEntityTypesListItem_evaluationMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerMetadataEntityTypesListItem' {Maybe EntityTypesEvaluationMetrics
evaluationMetrics :: Maybe EntityTypesEvaluationMetrics
$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem
-> Maybe EntityTypesEvaluationMetrics
evaluationMetrics} -> Maybe EntityTypesEvaluationMetrics
evaluationMetrics) (\s :: EntityRecognizerMetadataEntityTypesListItem
s@EntityRecognizerMetadataEntityTypesListItem' {} Maybe EntityTypesEvaluationMetrics
a -> EntityRecognizerMetadataEntityTypesListItem
s {$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem' :: Maybe EntityTypesEvaluationMetrics
evaluationMetrics = Maybe EntityTypesEvaluationMetrics
a} :: EntityRecognizerMetadataEntityTypesListItem)

-- | Indicates the number of times the given entity type was seen in the
-- training data.
entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens.Lens' EntityRecognizerMetadataEntityTypesListItem (Prelude.Maybe Prelude.Int)
entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int)
entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerMetadataEntityTypesListItem' {Maybe Int
numberOfTrainMentions :: Maybe Int
$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Int
numberOfTrainMentions} -> Maybe Int
numberOfTrainMentions) (\s :: EntityRecognizerMetadataEntityTypesListItem
s@EntityRecognizerMetadataEntityTypesListItem' {} Maybe Int
a -> EntityRecognizerMetadataEntityTypesListItem
s {$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem' :: Maybe Int
numberOfTrainMentions = Maybe Int
a} :: EntityRecognizerMetadataEntityTypesListItem)

-- | Type of entity from the list of entity types in the metadata of an
-- entity recognizer.
entityRecognizerMetadataEntityTypesListItem_type :: Lens.Lens' EntityRecognizerMetadataEntityTypesListItem (Prelude.Maybe Prelude.Text)
entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text)
entityRecognizerMetadataEntityTypesListItem_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerMetadataEntityTypesListItem' {Maybe Text
type' :: Maybe Text
$sel:type':EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Text
type'} -> Maybe Text
type') (\s :: EntityRecognizerMetadataEntityTypesListItem
s@EntityRecognizerMetadataEntityTypesListItem' {} Maybe Text
a -> EntityRecognizerMetadataEntityTypesListItem
s {$sel:type':EntityRecognizerMetadataEntityTypesListItem' :: Maybe Text
type' = Maybe Text
a} :: EntityRecognizerMetadataEntityTypesListItem)

instance
  Data.FromJSON
    EntityRecognizerMetadataEntityTypesListItem
  where
  parseJSON :: Value -> Parser EntityRecognizerMetadataEntityTypesListItem
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EntityRecognizerMetadataEntityTypesListItem"
      ( \Object
x ->
          Maybe EntityTypesEvaluationMetrics
-> Maybe Int
-> Maybe Text
-> EntityRecognizerMetadataEntityTypesListItem
EntityRecognizerMetadataEntityTypesListItem'
            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
"EvaluationMetrics")
            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
"NumberOfTrainMentions")
            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
"Type")
      )

instance
  Prelude.Hashable
    EntityRecognizerMetadataEntityTypesListItem
  where
  hashWithSalt :: Int -> EntityRecognizerMetadataEntityTypesListItem -> Int
hashWithSalt
    Int
_salt
    EntityRecognizerMetadataEntityTypesListItem' {Maybe Int
Maybe Text
Maybe EntityTypesEvaluationMetrics
type' :: Maybe Text
numberOfTrainMentions :: Maybe Int
evaluationMetrics :: Maybe EntityTypesEvaluationMetrics
$sel:type':EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Text
$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Int
$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem
-> Maybe EntityTypesEvaluationMetrics
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EntityTypesEvaluationMetrics
evaluationMetrics
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
numberOfTrainMentions
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
type'

instance
  Prelude.NFData
    EntityRecognizerMetadataEntityTypesListItem
  where
  rnf :: EntityRecognizerMetadataEntityTypesListItem -> ()
rnf EntityRecognizerMetadataEntityTypesListItem' {Maybe Int
Maybe Text
Maybe EntityTypesEvaluationMetrics
type' :: Maybe Text
numberOfTrainMentions :: Maybe Int
evaluationMetrics :: Maybe EntityTypesEvaluationMetrics
$sel:type':EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Text
$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Int
$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem' :: EntityRecognizerMetadataEntityTypesListItem
-> Maybe EntityTypesEvaluationMetrics
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EntityTypesEvaluationMetrics
evaluationMetrics
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
numberOfTrainMentions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
type'