{-# 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.Textract.Types.LendingResult
-- 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.Textract.Types.LendingResult where

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 Amazonka.Textract.Types.Extraction
import Amazonka.Textract.Types.PageClassification

-- | Contains the detections for each page analyzed through the Analyze
-- Lending API.
--
-- /See:/ 'newLendingResult' smart constructor.
data LendingResult = LendingResult'
  { -- | An array of Extraction to hold structured data. e.g. normalized key
    -- value pairs instead of raw OCR detections .
    LendingResult -> Maybe [Extraction]
extractions :: Prelude.Maybe [Extraction],
    -- | The page number for a page, with regard to whole submission.
    LendingResult -> Maybe Natural
page :: Prelude.Maybe Prelude.Natural,
    -- | The classifier result for a given page.
    LendingResult -> Maybe PageClassification
pageClassification :: Prelude.Maybe PageClassification
  }
  deriving (LendingResult -> LendingResult -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LendingResult -> LendingResult -> Bool
$c/= :: LendingResult -> LendingResult -> Bool
== :: LendingResult -> LendingResult -> Bool
$c== :: LendingResult -> LendingResult -> Bool
Prelude.Eq, ReadPrec [LendingResult]
ReadPrec LendingResult
Int -> ReadS LendingResult
ReadS [LendingResult]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [LendingResult]
$creadListPrec :: ReadPrec [LendingResult]
readPrec :: ReadPrec LendingResult
$creadPrec :: ReadPrec LendingResult
readList :: ReadS [LendingResult]
$creadList :: ReadS [LendingResult]
readsPrec :: Int -> ReadS LendingResult
$creadsPrec :: Int -> ReadS LendingResult
Prelude.Read, Int -> LendingResult -> ShowS
[LendingResult] -> ShowS
LendingResult -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LendingResult] -> ShowS
$cshowList :: [LendingResult] -> ShowS
show :: LendingResult -> String
$cshow :: LendingResult -> String
showsPrec :: Int -> LendingResult -> ShowS
$cshowsPrec :: Int -> LendingResult -> ShowS
Prelude.Show, forall x. Rep LendingResult x -> LendingResult
forall x. LendingResult -> Rep LendingResult x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep LendingResult x -> LendingResult
$cfrom :: forall x. LendingResult -> Rep LendingResult x
Prelude.Generic)

-- |
-- Create a value of 'LendingResult' 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:
--
-- 'extractions', 'lendingResult_extractions' - An array of Extraction to hold structured data. e.g. normalized key
-- value pairs instead of raw OCR detections .
--
-- 'page', 'lendingResult_page' - The page number for a page, with regard to whole submission.
--
-- 'pageClassification', 'lendingResult_pageClassification' - The classifier result for a given page.
newLendingResult ::
  LendingResult
newLendingResult :: LendingResult
newLendingResult =
  LendingResult'
    { $sel:extractions:LendingResult' :: Maybe [Extraction]
extractions = forall a. Maybe a
Prelude.Nothing,
      $sel:page:LendingResult' :: Maybe Natural
page = forall a. Maybe a
Prelude.Nothing,
      $sel:pageClassification:LendingResult' :: Maybe PageClassification
pageClassification = forall a. Maybe a
Prelude.Nothing
    }

-- | An array of Extraction to hold structured data. e.g. normalized key
-- value pairs instead of raw OCR detections .
lendingResult_extractions :: Lens.Lens' LendingResult (Prelude.Maybe [Extraction])
lendingResult_extractions :: Lens' LendingResult (Maybe [Extraction])
lendingResult_extractions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LendingResult' {Maybe [Extraction]
extractions :: Maybe [Extraction]
$sel:extractions:LendingResult' :: LendingResult -> Maybe [Extraction]
extractions} -> Maybe [Extraction]
extractions) (\s :: LendingResult
s@LendingResult' {} Maybe [Extraction]
a -> LendingResult
s {$sel:extractions:LendingResult' :: Maybe [Extraction]
extractions = Maybe [Extraction]
a} :: LendingResult) 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 page number for a page, with regard to whole submission.
lendingResult_page :: Lens.Lens' LendingResult (Prelude.Maybe Prelude.Natural)
lendingResult_page :: Lens' LendingResult (Maybe Natural)
lendingResult_page = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LendingResult' {Maybe Natural
page :: Maybe Natural
$sel:page:LendingResult' :: LendingResult -> Maybe Natural
page} -> Maybe Natural
page) (\s :: LendingResult
s@LendingResult' {} Maybe Natural
a -> LendingResult
s {$sel:page:LendingResult' :: Maybe Natural
page = Maybe Natural
a} :: LendingResult)

-- | The classifier result for a given page.
lendingResult_pageClassification :: Lens.Lens' LendingResult (Prelude.Maybe PageClassification)
lendingResult_pageClassification :: Lens' LendingResult (Maybe PageClassification)
lendingResult_pageClassification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LendingResult' {Maybe PageClassification
pageClassification :: Maybe PageClassification
$sel:pageClassification:LendingResult' :: LendingResult -> Maybe PageClassification
pageClassification} -> Maybe PageClassification
pageClassification) (\s :: LendingResult
s@LendingResult' {} Maybe PageClassification
a -> LendingResult
s {$sel:pageClassification:LendingResult' :: Maybe PageClassification
pageClassification = Maybe PageClassification
a} :: LendingResult)

instance Data.FromJSON LendingResult where
  parseJSON :: Value -> Parser LendingResult
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"LendingResult"
      ( \Object
x ->
          Maybe [Extraction]
-> Maybe Natural -> Maybe PageClassification -> LendingResult
LendingResult'
            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
"Extractions" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"Page")
            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
"PageClassification")
      )

instance Prelude.Hashable LendingResult where
  hashWithSalt :: Int -> LendingResult -> Int
hashWithSalt Int
_salt LendingResult' {Maybe Natural
Maybe [Extraction]
Maybe PageClassification
pageClassification :: Maybe PageClassification
page :: Maybe Natural
extractions :: Maybe [Extraction]
$sel:pageClassification:LendingResult' :: LendingResult -> Maybe PageClassification
$sel:page:LendingResult' :: LendingResult -> Maybe Natural
$sel:extractions:LendingResult' :: LendingResult -> Maybe [Extraction]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Extraction]
extractions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
page
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PageClassification
pageClassification

instance Prelude.NFData LendingResult where
  rnf :: LendingResult -> ()
rnf LendingResult' {Maybe Natural
Maybe [Extraction]
Maybe PageClassification
pageClassification :: Maybe PageClassification
page :: Maybe Natural
extractions :: Maybe [Extraction]
$sel:pageClassification:LendingResult' :: LendingResult -> Maybe PageClassification
$sel:page:LendingResult' :: LendingResult -> Maybe Natural
$sel:extractions:LendingResult' :: LendingResult -> Maybe [Extraction]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Extraction]
extractions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
page
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PageClassification
pageClassification