Trait.hs

{-# 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.ComprehendMedical.Types.Trait
-- 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.ComprehendMedical.Types.Trait where

import Amazonka.ComprehendMedical.Types.AttributeName
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

-- | Provides contextual information about the extracted entity.
--
-- /See:/ 'newTrait' smart constructor.
data Trait = Trait'
  { -- | Provides a name or contextual description about the trait.
    name :: Prelude.Maybe AttributeName,
    -- | The level of confidence that Comprehend Medical; has in the accuracy of
    -- this trait.
    score :: Prelude.Maybe Prelude.Double
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'Trait' 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', 'trait_name' - Provides a name or contextual description about the trait.
--
-- 'score', 'trait_score' - The level of confidence that Comprehend Medical; has in the accuracy of
-- this trait.
newTrait ::
  Trait
newTrait =
  Trait'
    { name = Prelude.Nothing,
      score = Prelude.Nothing
    }

-- | Provides a name or contextual description about the trait.
trait_name :: Lens.Lens' Trait (Prelude.Maybe AttributeName)
trait_name = Lens.lens (\Trait' {name} -> name) (\s@Trait' {} a -> s {name = a} :: Trait)

-- | The level of confidence that Comprehend Medical; has in the accuracy of
-- this trait.
trait_score :: Lens.Lens' Trait (Prelude.Maybe Prelude.Double)
trait_score = Lens.lens (\Trait' {score} -> score) (\s@Trait' {} a -> s {score = a} :: Trait)

instance Data.FromJSON Trait where
  parseJSON =
    Data.withObject
      "Trait"
      ( \x ->
          Trait'
            Prelude.<$> (x Data..:? "Name")
            Prelude.<*> (x Data..:? "Score")
      )

instance Prelude.Hashable Trait where
  hashWithSalt _salt Trait' {..} =
    _salt
      `Prelude.hashWithSalt` name
      `Prelude.hashWithSalt` score

instance Prelude.NFData Trait where
  rnf Trait' {..} =
    Prelude.rnf name `Prelude.seq` Prelude.rnf score