{-# 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.LexV2Models.Types.SlotValueSelectionSetting
-- 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.LexV2Models.Types.SlotValueSelectionSetting where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LexV2Models.Types.AdvancedRecognitionSetting
import Amazonka.LexV2Models.Types.SlotValueRegexFilter
import Amazonka.LexV2Models.Types.SlotValueResolutionStrategy
import qualified Amazonka.Prelude as Prelude

-- | Contains settings used by Amazon Lex to select a slot value.
--
-- /See:/ 'newSlotValueSelectionSetting' smart constructor.
data SlotValueSelectionSetting = SlotValueSelectionSetting'
  { -- | Provides settings that enable advanced recognition settings for slot
    -- values.
    SlotValueSelectionSetting -> Maybe AdvancedRecognitionSetting
advancedRecognitionSetting :: Prelude.Maybe AdvancedRecognitionSetting,
    -- | A regular expression used to validate the value of a slot.
    SlotValueSelectionSetting -> Maybe SlotValueRegexFilter
regexFilter :: Prelude.Maybe SlotValueRegexFilter,
    -- | Determines the slot resolution strategy that Amazon Lex uses to return
    -- slot type values. The field can be set to one of the following values:
    --
    -- -   OriginalValue - Returns the value entered by the user, if the user
    --     value is similar to the slot value.
    --
    -- -   TopResolution - If there is a resolution list for the slot, return
    --     the first value in the resolution list as the slot type value. If
    --     there is no resolution list, null is returned.
    --
    -- If you don\'t specify the valueSelectionStrategy, the default is
    -- OriginalValue.
    SlotValueSelectionSetting -> SlotValueResolutionStrategy
resolutionStrategy :: SlotValueResolutionStrategy
  }
  deriving (SlotValueSelectionSetting -> SlotValueSelectionSetting -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SlotValueSelectionSetting -> SlotValueSelectionSetting -> Bool
$c/= :: SlotValueSelectionSetting -> SlotValueSelectionSetting -> Bool
== :: SlotValueSelectionSetting -> SlotValueSelectionSetting -> Bool
$c== :: SlotValueSelectionSetting -> SlotValueSelectionSetting -> Bool
Prelude.Eq, ReadPrec [SlotValueSelectionSetting]
ReadPrec SlotValueSelectionSetting
Int -> ReadS SlotValueSelectionSetting
ReadS [SlotValueSelectionSetting]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SlotValueSelectionSetting]
$creadListPrec :: ReadPrec [SlotValueSelectionSetting]
readPrec :: ReadPrec SlotValueSelectionSetting
$creadPrec :: ReadPrec SlotValueSelectionSetting
readList :: ReadS [SlotValueSelectionSetting]
$creadList :: ReadS [SlotValueSelectionSetting]
readsPrec :: Int -> ReadS SlotValueSelectionSetting
$creadsPrec :: Int -> ReadS SlotValueSelectionSetting
Prelude.Read, Int -> SlotValueSelectionSetting -> ShowS
[SlotValueSelectionSetting] -> ShowS
SlotValueSelectionSetting -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SlotValueSelectionSetting] -> ShowS
$cshowList :: [SlotValueSelectionSetting] -> ShowS
show :: SlotValueSelectionSetting -> String
$cshow :: SlotValueSelectionSetting -> String
showsPrec :: Int -> SlotValueSelectionSetting -> ShowS
$cshowsPrec :: Int -> SlotValueSelectionSetting -> ShowS
Prelude.Show, forall x.
Rep SlotValueSelectionSetting x -> SlotValueSelectionSetting
forall x.
SlotValueSelectionSetting -> Rep SlotValueSelectionSetting x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SlotValueSelectionSetting x -> SlotValueSelectionSetting
$cfrom :: forall x.
SlotValueSelectionSetting -> Rep SlotValueSelectionSetting x
Prelude.Generic)

-- |
-- Create a value of 'SlotValueSelectionSetting' 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:
--
-- 'advancedRecognitionSetting', 'slotValueSelectionSetting_advancedRecognitionSetting' - Provides settings that enable advanced recognition settings for slot
-- values.
--
-- 'regexFilter', 'slotValueSelectionSetting_regexFilter' - A regular expression used to validate the value of a slot.
--
-- 'resolutionStrategy', 'slotValueSelectionSetting_resolutionStrategy' - Determines the slot resolution strategy that Amazon Lex uses to return
-- slot type values. The field can be set to one of the following values:
--
-- -   OriginalValue - Returns the value entered by the user, if the user
--     value is similar to the slot value.
--
-- -   TopResolution - If there is a resolution list for the slot, return
--     the first value in the resolution list as the slot type value. If
--     there is no resolution list, null is returned.
--
-- If you don\'t specify the valueSelectionStrategy, the default is
-- OriginalValue.
newSlotValueSelectionSetting ::
  -- | 'resolutionStrategy'
  SlotValueResolutionStrategy ->
  SlotValueSelectionSetting
newSlotValueSelectionSetting :: SlotValueResolutionStrategy -> SlotValueSelectionSetting
newSlotValueSelectionSetting SlotValueResolutionStrategy
pResolutionStrategy_ =
  SlotValueSelectionSetting'
    { $sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: Maybe AdvancedRecognitionSetting
advancedRecognitionSetting =
        forall a. Maybe a
Prelude.Nothing,
      $sel:regexFilter:SlotValueSelectionSetting' :: Maybe SlotValueRegexFilter
regexFilter = forall a. Maybe a
Prelude.Nothing,
      $sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueResolutionStrategy
resolutionStrategy = SlotValueResolutionStrategy
pResolutionStrategy_
    }

-- | Provides settings that enable advanced recognition settings for slot
-- values.
slotValueSelectionSetting_advancedRecognitionSetting :: Lens.Lens' SlotValueSelectionSetting (Prelude.Maybe AdvancedRecognitionSetting)
slotValueSelectionSetting_advancedRecognitionSetting :: Lens' SlotValueSelectionSetting (Maybe AdvancedRecognitionSetting)
slotValueSelectionSetting_advancedRecognitionSetting = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SlotValueSelectionSetting' {Maybe AdvancedRecognitionSetting
advancedRecognitionSetting :: Maybe AdvancedRecognitionSetting
$sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe AdvancedRecognitionSetting
advancedRecognitionSetting} -> Maybe AdvancedRecognitionSetting
advancedRecognitionSetting) (\s :: SlotValueSelectionSetting
s@SlotValueSelectionSetting' {} Maybe AdvancedRecognitionSetting
a -> SlotValueSelectionSetting
s {$sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: Maybe AdvancedRecognitionSetting
advancedRecognitionSetting = Maybe AdvancedRecognitionSetting
a} :: SlotValueSelectionSetting)

-- | A regular expression used to validate the value of a slot.
slotValueSelectionSetting_regexFilter :: Lens.Lens' SlotValueSelectionSetting (Prelude.Maybe SlotValueRegexFilter)
slotValueSelectionSetting_regexFilter :: Lens' SlotValueSelectionSetting (Maybe SlotValueRegexFilter)
slotValueSelectionSetting_regexFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SlotValueSelectionSetting' {Maybe SlotValueRegexFilter
regexFilter :: Maybe SlotValueRegexFilter
$sel:regexFilter:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe SlotValueRegexFilter
regexFilter} -> Maybe SlotValueRegexFilter
regexFilter) (\s :: SlotValueSelectionSetting
s@SlotValueSelectionSetting' {} Maybe SlotValueRegexFilter
a -> SlotValueSelectionSetting
s {$sel:regexFilter:SlotValueSelectionSetting' :: Maybe SlotValueRegexFilter
regexFilter = Maybe SlotValueRegexFilter
a} :: SlotValueSelectionSetting)

-- | Determines the slot resolution strategy that Amazon Lex uses to return
-- slot type values. The field can be set to one of the following values:
--
-- -   OriginalValue - Returns the value entered by the user, if the user
--     value is similar to the slot value.
--
-- -   TopResolution - If there is a resolution list for the slot, return
--     the first value in the resolution list as the slot type value. If
--     there is no resolution list, null is returned.
--
-- If you don\'t specify the valueSelectionStrategy, the default is
-- OriginalValue.
slotValueSelectionSetting_resolutionStrategy :: Lens.Lens' SlotValueSelectionSetting SlotValueResolutionStrategy
slotValueSelectionSetting_resolutionStrategy :: Lens' SlotValueSelectionSetting SlotValueResolutionStrategy
slotValueSelectionSetting_resolutionStrategy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SlotValueSelectionSetting' {SlotValueResolutionStrategy
resolutionStrategy :: SlotValueResolutionStrategy
$sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> SlotValueResolutionStrategy
resolutionStrategy} -> SlotValueResolutionStrategy
resolutionStrategy) (\s :: SlotValueSelectionSetting
s@SlotValueSelectionSetting' {} SlotValueResolutionStrategy
a -> SlotValueSelectionSetting
s {$sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueResolutionStrategy
resolutionStrategy = SlotValueResolutionStrategy
a} :: SlotValueSelectionSetting)

instance Data.FromJSON SlotValueSelectionSetting where
  parseJSON :: Value -> Parser SlotValueSelectionSetting
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SlotValueSelectionSetting"
      ( \Object
x ->
          Maybe AdvancedRecognitionSetting
-> Maybe SlotValueRegexFilter
-> SlotValueResolutionStrategy
-> SlotValueSelectionSetting
SlotValueSelectionSetting'
            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
"advancedRecognitionSetting")
            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
"regexFilter")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"resolutionStrategy")
      )

instance Prelude.Hashable SlotValueSelectionSetting where
  hashWithSalt :: Int -> SlotValueSelectionSetting -> Int
hashWithSalt Int
_salt SlotValueSelectionSetting' {Maybe AdvancedRecognitionSetting
Maybe SlotValueRegexFilter
SlotValueResolutionStrategy
resolutionStrategy :: SlotValueResolutionStrategy
regexFilter :: Maybe SlotValueRegexFilter
advancedRecognitionSetting :: Maybe AdvancedRecognitionSetting
$sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> SlotValueResolutionStrategy
$sel:regexFilter:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe SlotValueRegexFilter
$sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe AdvancedRecognitionSetting
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AdvancedRecognitionSetting
advancedRecognitionSetting
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SlotValueRegexFilter
regexFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` SlotValueResolutionStrategy
resolutionStrategy

instance Prelude.NFData SlotValueSelectionSetting where
  rnf :: SlotValueSelectionSetting -> ()
rnf SlotValueSelectionSetting' {Maybe AdvancedRecognitionSetting
Maybe SlotValueRegexFilter
SlotValueResolutionStrategy
resolutionStrategy :: SlotValueResolutionStrategy
regexFilter :: Maybe SlotValueRegexFilter
advancedRecognitionSetting :: Maybe AdvancedRecognitionSetting
$sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> SlotValueResolutionStrategy
$sel:regexFilter:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe SlotValueRegexFilter
$sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe AdvancedRecognitionSetting
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AdvancedRecognitionSetting
advancedRecognitionSetting
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SlotValueRegexFilter
regexFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf SlotValueResolutionStrategy
resolutionStrategy

instance Data.ToJSON SlotValueSelectionSetting where
  toJSON :: SlotValueSelectionSetting -> Value
toJSON SlotValueSelectionSetting' {Maybe AdvancedRecognitionSetting
Maybe SlotValueRegexFilter
SlotValueResolutionStrategy
resolutionStrategy :: SlotValueResolutionStrategy
regexFilter :: Maybe SlotValueRegexFilter
advancedRecognitionSetting :: Maybe AdvancedRecognitionSetting
$sel:resolutionStrategy:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> SlotValueResolutionStrategy
$sel:regexFilter:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe SlotValueRegexFilter
$sel:advancedRecognitionSetting:SlotValueSelectionSetting' :: SlotValueSelectionSetting -> Maybe AdvancedRecognitionSetting
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"advancedRecognitionSetting" 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 AdvancedRecognitionSetting
advancedRecognitionSetting,
            (Key
"regexFilter" 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 SlotValueRegexFilter
regexFilter,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"resolutionStrategy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= SlotValueResolutionStrategy
resolutionStrategy)
          ]
      )