{-# 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.Kendra.Types.ScoreAttributes
-- 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.Kendra.Types.ScoreAttributes where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types.ScoreConfidence
import qualified Amazonka.Prelude as Prelude

-- | Provides a relative ranking that indicates how confident Amazon Kendra
-- is that the response matches the query.
--
-- /See:/ 'newScoreAttributes' smart constructor.
data ScoreAttributes = ScoreAttributes'
  { -- | A relative ranking for how well the response matches the query.
    scoreConfidence :: Prelude.Maybe ScoreConfidence
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ScoreAttributes' 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:
--
-- 'scoreConfidence', 'scoreAttributes_scoreConfidence' - A relative ranking for how well the response matches the query.
newScoreAttributes ::
  ScoreAttributes
newScoreAttributes =
  ScoreAttributes' {scoreConfidence = Prelude.Nothing}

-- | A relative ranking for how well the response matches the query.
scoreAttributes_scoreConfidence :: Lens.Lens' ScoreAttributes (Prelude.Maybe ScoreConfidence)
scoreAttributes_scoreConfidence = Lens.lens (\ScoreAttributes' {scoreConfidence} -> scoreConfidence) (\s@ScoreAttributes' {} a -> s {scoreConfidence = a} :: ScoreAttributes)

instance Data.FromJSON ScoreAttributes where
  parseJSON =
    Data.withObject
      "ScoreAttributes"
      ( \x ->
          ScoreAttributes'
            Prelude.<$> (x Data..:? "ScoreConfidence")
      )

instance Prelude.Hashable ScoreAttributes where
  hashWithSalt _salt ScoreAttributes' {..} =
    _salt `Prelude.hashWithSalt` scoreConfidence

instance Prelude.NFData ScoreAttributes where
  rnf ScoreAttributes' {..} =
    Prelude.rnf scoreConfidence