{-# 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.RelevanceFeedback
-- 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.RelevanceFeedback 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.RelevanceType
import qualified Amazonka.Prelude as Prelude

-- | Provides feedback on how relevant a document is to a search. Your
-- application uses the @SubmitFeedback@ API to provide relevance
-- information.
--
-- /See:/ 'newRelevanceFeedback' smart constructor.
data RelevanceFeedback = RelevanceFeedback'
  { -- | The identifier of the search result that the user provided relevance
    -- feedback for.
    RelevanceFeedback -> Text
resultId :: Prelude.Text,
    -- | Whether to document was relevant or not relevant to the search.
    RelevanceFeedback -> RelevanceType
relevanceValue :: RelevanceType
  }
  deriving (RelevanceFeedback -> RelevanceFeedback -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RelevanceFeedback -> RelevanceFeedback -> Bool
$c/= :: RelevanceFeedback -> RelevanceFeedback -> Bool
== :: RelevanceFeedback -> RelevanceFeedback -> Bool
$c== :: RelevanceFeedback -> RelevanceFeedback -> Bool
Prelude.Eq, ReadPrec [RelevanceFeedback]
ReadPrec RelevanceFeedback
Int -> ReadS RelevanceFeedback
ReadS [RelevanceFeedback]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RelevanceFeedback]
$creadListPrec :: ReadPrec [RelevanceFeedback]
readPrec :: ReadPrec RelevanceFeedback
$creadPrec :: ReadPrec RelevanceFeedback
readList :: ReadS [RelevanceFeedback]
$creadList :: ReadS [RelevanceFeedback]
readsPrec :: Int -> ReadS RelevanceFeedback
$creadsPrec :: Int -> ReadS RelevanceFeedback
Prelude.Read, Int -> RelevanceFeedback -> ShowS
[RelevanceFeedback] -> ShowS
RelevanceFeedback -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RelevanceFeedback] -> ShowS
$cshowList :: [RelevanceFeedback] -> ShowS
show :: RelevanceFeedback -> String
$cshow :: RelevanceFeedback -> String
showsPrec :: Int -> RelevanceFeedback -> ShowS
$cshowsPrec :: Int -> RelevanceFeedback -> ShowS
Prelude.Show, forall x. Rep RelevanceFeedback x -> RelevanceFeedback
forall x. RelevanceFeedback -> Rep RelevanceFeedback x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RelevanceFeedback x -> RelevanceFeedback
$cfrom :: forall x. RelevanceFeedback -> Rep RelevanceFeedback x
Prelude.Generic)

-- |
-- Create a value of 'RelevanceFeedback' 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:
--
-- 'resultId', 'relevanceFeedback_resultId' - The identifier of the search result that the user provided relevance
-- feedback for.
--
-- 'relevanceValue', 'relevanceFeedback_relevanceValue' - Whether to document was relevant or not relevant to the search.
newRelevanceFeedback ::
  -- | 'resultId'
  Prelude.Text ->
  -- | 'relevanceValue'
  RelevanceType ->
  RelevanceFeedback
newRelevanceFeedback :: Text -> RelevanceType -> RelevanceFeedback
newRelevanceFeedback Text
pResultId_ RelevanceType
pRelevanceValue_ =
  RelevanceFeedback'
    { $sel:resultId:RelevanceFeedback' :: Text
resultId = Text
pResultId_,
      $sel:relevanceValue:RelevanceFeedback' :: RelevanceType
relevanceValue = RelevanceType
pRelevanceValue_
    }

-- | The identifier of the search result that the user provided relevance
-- feedback for.
relevanceFeedback_resultId :: Lens.Lens' RelevanceFeedback Prelude.Text
relevanceFeedback_resultId :: Lens' RelevanceFeedback Text
relevanceFeedback_resultId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RelevanceFeedback' {Text
resultId :: Text
$sel:resultId:RelevanceFeedback' :: RelevanceFeedback -> Text
resultId} -> Text
resultId) (\s :: RelevanceFeedback
s@RelevanceFeedback' {} Text
a -> RelevanceFeedback
s {$sel:resultId:RelevanceFeedback' :: Text
resultId = Text
a} :: RelevanceFeedback)

-- | Whether to document was relevant or not relevant to the search.
relevanceFeedback_relevanceValue :: Lens.Lens' RelevanceFeedback RelevanceType
relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType
relevanceFeedback_relevanceValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RelevanceFeedback' {RelevanceType
relevanceValue :: RelevanceType
$sel:relevanceValue:RelevanceFeedback' :: RelevanceFeedback -> RelevanceType
relevanceValue} -> RelevanceType
relevanceValue) (\s :: RelevanceFeedback
s@RelevanceFeedback' {} RelevanceType
a -> RelevanceFeedback
s {$sel:relevanceValue:RelevanceFeedback' :: RelevanceType
relevanceValue = RelevanceType
a} :: RelevanceFeedback)

instance Prelude.Hashable RelevanceFeedback where
  hashWithSalt :: Int -> RelevanceFeedback -> Int
hashWithSalt Int
_salt RelevanceFeedback' {Text
RelevanceType
relevanceValue :: RelevanceType
resultId :: Text
$sel:relevanceValue:RelevanceFeedback' :: RelevanceFeedback -> RelevanceType
$sel:resultId:RelevanceFeedback' :: RelevanceFeedback -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
resultId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` RelevanceType
relevanceValue

instance Prelude.NFData RelevanceFeedback where
  rnf :: RelevanceFeedback -> ()
rnf RelevanceFeedback' {Text
RelevanceType
relevanceValue :: RelevanceType
resultId :: Text
$sel:relevanceValue:RelevanceFeedback' :: RelevanceFeedback -> RelevanceType
$sel:resultId:RelevanceFeedback' :: RelevanceFeedback -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
resultId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf RelevanceType
relevanceValue

instance Data.ToJSON RelevanceFeedback where
  toJSON :: RelevanceFeedback -> Value
toJSON RelevanceFeedback' {Text
RelevanceType
relevanceValue :: RelevanceType
resultId :: Text
$sel:relevanceValue:RelevanceFeedback' :: RelevanceFeedback -> RelevanceType
$sel:resultId:RelevanceFeedback' :: RelevanceFeedback -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"ResultId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
resultId),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"RelevanceValue" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= RelevanceType
relevanceValue)
          ]
      )