{-# 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.Entity
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Comprehend.Types.Entity where

import Amazonka.Comprehend.Types.EntityType
import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Provides information about an entity.
--
-- /See:/ 'newEntity' smart constructor.
data Entity = Entity'
  { -- | A character offset in the input text that shows where the entity begins
    -- (the first character is at position 0). The offset returns the position
    -- of each UTF-8 code point in the string. A /code point/ is the abstract
    -- character from a particular graphical representation. For example, a
    -- multi-byte UTF-8 character maps to a single code point.
    Entity -> Maybe Int
beginOffset :: Prelude.Maybe Prelude.Int,
    -- | The text of the entity.
    Entity -> Maybe Text
text :: Prelude.Maybe Prelude.Text,
    -- | The level of confidence that Amazon Comprehend has in the accuracy of
    -- the detection.
    Entity -> Maybe Double
score :: Prelude.Maybe Prelude.Double,
    -- | A character offset in the input text that shows where the entity ends.
    -- The offset returns the position of each UTF-8 code point in the string.
    -- A /code point/ is the abstract character from a particular graphical
    -- representation. For example, a multi-byte UTF-8 character maps to a
    -- single code point.
    Entity -> Maybe Int
endOffset :: Prelude.Maybe Prelude.Int,
    -- | The entity\'s type.
    Entity -> Maybe EntityType
type' :: Prelude.Maybe EntityType
  }
  deriving (Entity -> Entity -> Bool
(Entity -> Entity -> Bool)
-> (Entity -> Entity -> Bool) -> Eq Entity
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Entity -> Entity -> Bool
$c/= :: Entity -> Entity -> Bool
== :: Entity -> Entity -> Bool
$c== :: Entity -> Entity -> Bool
Prelude.Eq, ReadPrec [Entity]
ReadPrec Entity
Int -> ReadS Entity
ReadS [Entity]
(Int -> ReadS Entity)
-> ReadS [Entity]
-> ReadPrec Entity
-> ReadPrec [Entity]
-> Read Entity
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Entity]
$creadListPrec :: ReadPrec [Entity]
readPrec :: ReadPrec Entity
$creadPrec :: ReadPrec Entity
readList :: ReadS [Entity]
$creadList :: ReadS [Entity]
readsPrec :: Int -> ReadS Entity
$creadsPrec :: Int -> ReadS Entity
Prelude.Read, Int -> Entity -> ShowS
[Entity] -> ShowS
Entity -> String
(Int -> Entity -> ShowS)
-> (Entity -> String) -> ([Entity] -> ShowS) -> Show Entity
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Entity] -> ShowS
$cshowList :: [Entity] -> ShowS
show :: Entity -> String
$cshow :: Entity -> String
showsPrec :: Int -> Entity -> ShowS
$cshowsPrec :: Int -> Entity -> ShowS
Prelude.Show, (forall x. Entity -> Rep Entity x)
-> (forall x. Rep Entity x -> Entity) -> Generic Entity
forall x. Rep Entity x -> Entity
forall x. Entity -> Rep Entity x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Entity x -> Entity
$cfrom :: forall x. Entity -> Rep Entity x
Prelude.Generic)

-- |
-- Create a value of 'Entity' 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:
--
-- 'beginOffset', 'entity_beginOffset' - A character offset in the input text that shows where the entity begins
-- (the first character is at position 0). The offset returns the position
-- of each UTF-8 code point in the string. A /code point/ is the abstract
-- character from a particular graphical representation. For example, a
-- multi-byte UTF-8 character maps to a single code point.
--
-- 'text', 'entity_text' - The text of the entity.
--
-- 'score', 'entity_score' - The level of confidence that Amazon Comprehend has in the accuracy of
-- the detection.
--
-- 'endOffset', 'entity_endOffset' - A character offset in the input text that shows where the entity ends.
-- The offset returns the position of each UTF-8 code point in the string.
-- A /code point/ is the abstract character from a particular graphical
-- representation. For example, a multi-byte UTF-8 character maps to a
-- single code point.
--
-- 'type'', 'entity_type' - The entity\'s type.
newEntity ::
  Entity
newEntity :: Entity
newEntity =
  Entity' :: Maybe Int
-> Maybe Text
-> Maybe Double
-> Maybe Int
-> Maybe EntityType
-> Entity
Entity'
    { $sel:beginOffset:Entity' :: Maybe Int
beginOffset = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:text:Entity' :: Maybe Text
text = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:score:Entity' :: Maybe Double
score = Maybe Double
forall a. Maybe a
Prelude.Nothing,
      $sel:endOffset:Entity' :: Maybe Int
endOffset = Maybe Int
forall a. Maybe a
Prelude.Nothing,
      $sel:type':Entity' :: Maybe EntityType
type' = Maybe EntityType
forall a. Maybe a
Prelude.Nothing
    }

-- | A character offset in the input text that shows where the entity begins
-- (the first character is at position 0). The offset returns the position
-- of each UTF-8 code point in the string. A /code point/ is the abstract
-- character from a particular graphical representation. For example, a
-- multi-byte UTF-8 character maps to a single code point.
entity_beginOffset :: Lens.Lens' Entity (Prelude.Maybe Prelude.Int)
entity_beginOffset :: (Maybe Int -> f (Maybe Int)) -> Entity -> f Entity
entity_beginOffset = (Entity -> Maybe Int)
-> (Entity -> Maybe Int -> Entity)
-> Lens Entity Entity (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Entity' {Maybe Int
beginOffset :: Maybe Int
$sel:beginOffset:Entity' :: Entity -> Maybe Int
beginOffset} -> Maybe Int
beginOffset) (\s :: Entity
s@Entity' {} Maybe Int
a -> Entity
s {$sel:beginOffset:Entity' :: Maybe Int
beginOffset = Maybe Int
a} :: Entity)

-- | The text of the entity.
entity_text :: Lens.Lens' Entity (Prelude.Maybe Prelude.Text)
entity_text :: (Maybe Text -> f (Maybe Text)) -> Entity -> f Entity
entity_text = (Entity -> Maybe Text)
-> (Entity -> Maybe Text -> Entity)
-> Lens Entity Entity (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Entity' {Maybe Text
text :: Maybe Text
$sel:text:Entity' :: Entity -> Maybe Text
text} -> Maybe Text
text) (\s :: Entity
s@Entity' {} Maybe Text
a -> Entity
s {$sel:text:Entity' :: Maybe Text
text = Maybe Text
a} :: Entity)

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

-- | A character offset in the input text that shows where the entity ends.
-- The offset returns the position of each UTF-8 code point in the string.
-- A /code point/ is the abstract character from a particular graphical
-- representation. For example, a multi-byte UTF-8 character maps to a
-- single code point.
entity_endOffset :: Lens.Lens' Entity (Prelude.Maybe Prelude.Int)
entity_endOffset :: (Maybe Int -> f (Maybe Int)) -> Entity -> f Entity
entity_endOffset = (Entity -> Maybe Int)
-> (Entity -> Maybe Int -> Entity)
-> Lens Entity Entity (Maybe Int) (Maybe Int)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Entity' {Maybe Int
endOffset :: Maybe Int
$sel:endOffset:Entity' :: Entity -> Maybe Int
endOffset} -> Maybe Int
endOffset) (\s :: Entity
s@Entity' {} Maybe Int
a -> Entity
s {$sel:endOffset:Entity' :: Maybe Int
endOffset = Maybe Int
a} :: Entity)

-- | The entity\'s type.
entity_type :: Lens.Lens' Entity (Prelude.Maybe EntityType)
entity_type :: (Maybe EntityType -> f (Maybe EntityType)) -> Entity -> f Entity
entity_type = (Entity -> Maybe EntityType)
-> (Entity -> Maybe EntityType -> Entity)
-> Lens Entity Entity (Maybe EntityType) (Maybe EntityType)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Entity' {Maybe EntityType
type' :: Maybe EntityType
$sel:type':Entity' :: Entity -> Maybe EntityType
type'} -> Maybe EntityType
type') (\s :: Entity
s@Entity' {} Maybe EntityType
a -> Entity
s {$sel:type':Entity' :: Maybe EntityType
type' = Maybe EntityType
a} :: Entity)

instance Core.FromJSON Entity where
  parseJSON :: Value -> Parser Entity
parseJSON =
    String -> (Object -> Parser Entity) -> Value -> Parser Entity
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"Entity"
      ( \Object
x ->
          Maybe Int
-> Maybe Text
-> Maybe Double
-> Maybe Int
-> Maybe EntityType
-> Entity
Entity'
            (Maybe Int
 -> Maybe Text
 -> Maybe Double
 -> Maybe Int
 -> Maybe EntityType
 -> Entity)
-> Parser (Maybe Int)
-> Parser
     (Maybe Text
      -> Maybe Double -> Maybe Int -> Maybe EntityType -> Entity)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"BeginOffset")
            Parser
  (Maybe Text
   -> Maybe Double -> Maybe Int -> Maybe EntityType -> Entity)
-> Parser (Maybe Text)
-> Parser (Maybe Double -> Maybe Int -> Maybe EntityType -> Entity)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Text")
            Parser (Maybe Double -> Maybe Int -> Maybe EntityType -> Entity)
-> Parser (Maybe Double)
-> Parser (Maybe Int -> Maybe EntityType -> Entity)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Double)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Score")
            Parser (Maybe Int -> Maybe EntityType -> Entity)
-> Parser (Maybe Int) -> Parser (Maybe EntityType -> Entity)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"EndOffset")
            Parser (Maybe EntityType -> Entity)
-> Parser (Maybe EntityType) -> Parser Entity
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe EntityType)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Type")
      )

instance Prelude.Hashable Entity

instance Prelude.NFData Entity