{-# 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.Personalize.Types.RecommenderConfig
-- 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.Personalize.Types.RecommenderConfig 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

-- | The configuration details of the recommender.
--
-- /See:/ 'newRecommenderConfig' smart constructor.
data RecommenderConfig = RecommenderConfig'
  { -- | Specifies the exploration configuration hyperparameters, including
    -- @explorationWeight@ and @explorationItemAgeCutOff@, you want to use to
    -- configure the amount of item exploration Amazon Personalize uses when
    -- recommending items. Provide @itemExplorationConfig@ data only if your
    -- recommenders generate personalized recommendations for a user (not
    -- popular items or similar items).
    RecommenderConfig -> Maybe (HashMap Text Text)
itemExplorationConfig :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | Specifies the requested minimum provisioned recommendation requests per
    -- second that Amazon Personalize will support.
    RecommenderConfig -> Maybe Natural
minRecommendationRequestsPerSecond :: Prelude.Maybe Prelude.Natural
  }
  deriving (RecommenderConfig -> RecommenderConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RecommenderConfig -> RecommenderConfig -> Bool
$c/= :: RecommenderConfig -> RecommenderConfig -> Bool
== :: RecommenderConfig -> RecommenderConfig -> Bool
$c== :: RecommenderConfig -> RecommenderConfig -> Bool
Prelude.Eq, ReadPrec [RecommenderConfig]
ReadPrec RecommenderConfig
Int -> ReadS RecommenderConfig
ReadS [RecommenderConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RecommenderConfig]
$creadListPrec :: ReadPrec [RecommenderConfig]
readPrec :: ReadPrec RecommenderConfig
$creadPrec :: ReadPrec RecommenderConfig
readList :: ReadS [RecommenderConfig]
$creadList :: ReadS [RecommenderConfig]
readsPrec :: Int -> ReadS RecommenderConfig
$creadsPrec :: Int -> ReadS RecommenderConfig
Prelude.Read, Int -> RecommenderConfig -> ShowS
[RecommenderConfig] -> ShowS
RecommenderConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RecommenderConfig] -> ShowS
$cshowList :: [RecommenderConfig] -> ShowS
show :: RecommenderConfig -> String
$cshow :: RecommenderConfig -> String
showsPrec :: Int -> RecommenderConfig -> ShowS
$cshowsPrec :: Int -> RecommenderConfig -> ShowS
Prelude.Show, forall x. Rep RecommenderConfig x -> RecommenderConfig
forall x. RecommenderConfig -> Rep RecommenderConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RecommenderConfig x -> RecommenderConfig
$cfrom :: forall x. RecommenderConfig -> Rep RecommenderConfig x
Prelude.Generic)

-- |
-- Create a value of 'RecommenderConfig' 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:
--
-- 'itemExplorationConfig', 'recommenderConfig_itemExplorationConfig' - Specifies the exploration configuration hyperparameters, including
-- @explorationWeight@ and @explorationItemAgeCutOff@, you want to use to
-- configure the amount of item exploration Amazon Personalize uses when
-- recommending items. Provide @itemExplorationConfig@ data only if your
-- recommenders generate personalized recommendations for a user (not
-- popular items or similar items).
--
-- 'minRecommendationRequestsPerSecond', 'recommenderConfig_minRecommendationRequestsPerSecond' - Specifies the requested minimum provisioned recommendation requests per
-- second that Amazon Personalize will support.
newRecommenderConfig ::
  RecommenderConfig
newRecommenderConfig :: RecommenderConfig
newRecommenderConfig =
  RecommenderConfig'
    { $sel:itemExplorationConfig:RecommenderConfig' :: Maybe (HashMap Text Text)
itemExplorationConfig =
        forall a. Maybe a
Prelude.Nothing,
      $sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: Maybe Natural
minRecommendationRequestsPerSecond = forall a. Maybe a
Prelude.Nothing
    }

-- | Specifies the exploration configuration hyperparameters, including
-- @explorationWeight@ and @explorationItemAgeCutOff@, you want to use to
-- configure the amount of item exploration Amazon Personalize uses when
-- recommending items. Provide @itemExplorationConfig@ data only if your
-- recommenders generate personalized recommendations for a user (not
-- popular items or similar items).
recommenderConfig_itemExplorationConfig :: Lens.Lens' RecommenderConfig (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
recommenderConfig_itemExplorationConfig :: Lens' RecommenderConfig (Maybe (HashMap Text Text))
recommenderConfig_itemExplorationConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderConfig' {Maybe (HashMap Text Text)
itemExplorationConfig :: Maybe (HashMap Text Text)
$sel:itemExplorationConfig:RecommenderConfig' :: RecommenderConfig -> Maybe (HashMap Text Text)
itemExplorationConfig} -> Maybe (HashMap Text Text)
itemExplorationConfig) (\s :: RecommenderConfig
s@RecommenderConfig' {} Maybe (HashMap Text Text)
a -> RecommenderConfig
s {$sel:itemExplorationConfig:RecommenderConfig' :: Maybe (HashMap Text Text)
itemExplorationConfig = Maybe (HashMap Text Text)
a} :: RecommenderConfig) 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

-- | Specifies the requested minimum provisioned recommendation requests per
-- second that Amazon Personalize will support.
recommenderConfig_minRecommendationRequestsPerSecond :: Lens.Lens' RecommenderConfig (Prelude.Maybe Prelude.Natural)
recommenderConfig_minRecommendationRequestsPerSecond :: Lens' RecommenderConfig (Maybe Natural)
recommenderConfig_minRecommendationRequestsPerSecond = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderConfig' {Maybe Natural
minRecommendationRequestsPerSecond :: Maybe Natural
$sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: RecommenderConfig -> Maybe Natural
minRecommendationRequestsPerSecond} -> Maybe Natural
minRecommendationRequestsPerSecond) (\s :: RecommenderConfig
s@RecommenderConfig' {} Maybe Natural
a -> RecommenderConfig
s {$sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: Maybe Natural
minRecommendationRequestsPerSecond = Maybe Natural
a} :: RecommenderConfig)

instance Data.FromJSON RecommenderConfig where
  parseJSON :: Value -> Parser RecommenderConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"RecommenderConfig"
      ( \Object
x ->
          Maybe (HashMap Text Text) -> Maybe Natural -> RecommenderConfig
RecommenderConfig'
            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
"itemExplorationConfig"
                            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
"minRecommendationRequestsPerSecond")
      )

instance Prelude.Hashable RecommenderConfig where
  hashWithSalt :: Int -> RecommenderConfig -> Int
hashWithSalt Int
_salt RecommenderConfig' {Maybe Natural
Maybe (HashMap Text Text)
minRecommendationRequestsPerSecond :: Maybe Natural
itemExplorationConfig :: Maybe (HashMap Text Text)
$sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: RecommenderConfig -> Maybe Natural
$sel:itemExplorationConfig:RecommenderConfig' :: RecommenderConfig -> Maybe (HashMap Text Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
itemExplorationConfig
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
minRecommendationRequestsPerSecond

instance Prelude.NFData RecommenderConfig where
  rnf :: RecommenderConfig -> ()
rnf RecommenderConfig' {Maybe Natural
Maybe (HashMap Text Text)
minRecommendationRequestsPerSecond :: Maybe Natural
itemExplorationConfig :: Maybe (HashMap Text Text)
$sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: RecommenderConfig -> Maybe Natural
$sel:itemExplorationConfig:RecommenderConfig' :: RecommenderConfig -> Maybe (HashMap Text Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
itemExplorationConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
minRecommendationRequestsPerSecond

instance Data.ToJSON RecommenderConfig where
  toJSON :: RecommenderConfig -> Value
toJSON RecommenderConfig' {Maybe Natural
Maybe (HashMap Text Text)
minRecommendationRequestsPerSecond :: Maybe Natural
itemExplorationConfig :: Maybe (HashMap Text Text)
$sel:minRecommendationRequestsPerSecond:RecommenderConfig' :: RecommenderConfig -> Maybe Natural
$sel:itemExplorationConfig:RecommenderConfig' :: RecommenderConfig -> Maybe (HashMap Text Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"itemExplorationConfig" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Text)
itemExplorationConfig,
            (Key
"minRecommendationRequestsPerSecond" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
minRecommendationRequestsPerSecond
          ]
      )