{-# 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.SubSlotValueElicitationSetting
-- 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.SubSlotValueElicitationSetting 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.PromptSpecification
import Amazonka.LexV2Models.Types.SampleUtterance
import Amazonka.LexV2Models.Types.SlotDefaultValueSpecification
import Amazonka.LexV2Models.Types.WaitAndContinueSpecification
import qualified Amazonka.Prelude as Prelude

-- | Subslot elicitation settings.
--
-- @DefaultValueSpecification@ is a list of default values for a
-- constituent sub slot in a composite slot. Default values are used when
-- Amazon Lex hasn\'t determined a value for a slot. You can specify
-- default values from context variables, session attributes, and defined
-- values. This is similar to @DefaultValueSpecification@ for slots.
--
-- @PromptSpecification@ is the prompt that Amazon Lex uses to elicit the
-- sub slot value from the user. This is similar to @PromptSpecification@
-- for slots.
--
-- /See:/ 'newSubSlotValueElicitationSetting' smart constructor.
data SubSlotValueElicitationSetting = SubSlotValueElicitationSetting'
  { SubSlotValueElicitationSetting
-> Maybe SlotDefaultValueSpecification
defaultValueSpecification :: Prelude.Maybe SlotDefaultValueSpecification,
    -- | If you know a specific pattern that users might respond to an Amazon Lex
    -- request for a sub slot value, you can provide those utterances to
    -- improve accuracy. This is optional. In most cases Amazon Lex is capable
    -- of understanding user utterances. This is similar to @SampleUtterances@
    -- for slots.
    SubSlotValueElicitationSetting -> Maybe [SampleUtterance]
sampleUtterances :: Prelude.Maybe [SampleUtterance],
    SubSlotValueElicitationSetting
-> Maybe WaitAndContinueSpecification
waitAndContinueSpecification :: Prelude.Maybe WaitAndContinueSpecification,
    SubSlotValueElicitationSetting -> PromptSpecification
promptSpecification :: PromptSpecification
  }
  deriving (SubSlotValueElicitationSetting
-> SubSlotValueElicitationSetting -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SubSlotValueElicitationSetting
-> SubSlotValueElicitationSetting -> Bool
$c/= :: SubSlotValueElicitationSetting
-> SubSlotValueElicitationSetting -> Bool
== :: SubSlotValueElicitationSetting
-> SubSlotValueElicitationSetting -> Bool
$c== :: SubSlotValueElicitationSetting
-> SubSlotValueElicitationSetting -> Bool
Prelude.Eq, ReadPrec [SubSlotValueElicitationSetting]
ReadPrec SubSlotValueElicitationSetting
Int -> ReadS SubSlotValueElicitationSetting
ReadS [SubSlotValueElicitationSetting]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SubSlotValueElicitationSetting]
$creadListPrec :: ReadPrec [SubSlotValueElicitationSetting]
readPrec :: ReadPrec SubSlotValueElicitationSetting
$creadPrec :: ReadPrec SubSlotValueElicitationSetting
readList :: ReadS [SubSlotValueElicitationSetting]
$creadList :: ReadS [SubSlotValueElicitationSetting]
readsPrec :: Int -> ReadS SubSlotValueElicitationSetting
$creadsPrec :: Int -> ReadS SubSlotValueElicitationSetting
Prelude.Read, Int -> SubSlotValueElicitationSetting -> ShowS
[SubSlotValueElicitationSetting] -> ShowS
SubSlotValueElicitationSetting -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SubSlotValueElicitationSetting] -> ShowS
$cshowList :: [SubSlotValueElicitationSetting] -> ShowS
show :: SubSlotValueElicitationSetting -> String
$cshow :: SubSlotValueElicitationSetting -> String
showsPrec :: Int -> SubSlotValueElicitationSetting -> ShowS
$cshowsPrec :: Int -> SubSlotValueElicitationSetting -> ShowS
Prelude.Show, forall x.
Rep SubSlotValueElicitationSetting x
-> SubSlotValueElicitationSetting
forall x.
SubSlotValueElicitationSetting
-> Rep SubSlotValueElicitationSetting x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SubSlotValueElicitationSetting x
-> SubSlotValueElicitationSetting
$cfrom :: forall x.
SubSlotValueElicitationSetting
-> Rep SubSlotValueElicitationSetting x
Prelude.Generic)

-- |
-- Create a value of 'SubSlotValueElicitationSetting' 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:
--
-- 'defaultValueSpecification', 'subSlotValueElicitationSetting_defaultValueSpecification' - Undocumented member.
--
-- 'sampleUtterances', 'subSlotValueElicitationSetting_sampleUtterances' - If you know a specific pattern that users might respond to an Amazon Lex
-- request for a sub slot value, you can provide those utterances to
-- improve accuracy. This is optional. In most cases Amazon Lex is capable
-- of understanding user utterances. This is similar to @SampleUtterances@
-- for slots.
--
-- 'waitAndContinueSpecification', 'subSlotValueElicitationSetting_waitAndContinueSpecification' - Undocumented member.
--
-- 'promptSpecification', 'subSlotValueElicitationSetting_promptSpecification' - Undocumented member.
newSubSlotValueElicitationSetting ::
  -- | 'promptSpecification'
  PromptSpecification ->
  SubSlotValueElicitationSetting
newSubSlotValueElicitationSetting :: PromptSpecification -> SubSlotValueElicitationSetting
newSubSlotValueElicitationSetting
  PromptSpecification
pPromptSpecification_ =
    SubSlotValueElicitationSetting'
      { $sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: Maybe SlotDefaultValueSpecification
defaultValueSpecification =
          forall a. Maybe a
Prelude.Nothing,
        $sel:sampleUtterances:SubSlotValueElicitationSetting' :: Maybe [SampleUtterance]
sampleUtterances = forall a. Maybe a
Prelude.Nothing,
        $sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: Maybe WaitAndContinueSpecification
waitAndContinueSpecification =
          forall a. Maybe a
Prelude.Nothing,
        $sel:promptSpecification:SubSlotValueElicitationSetting' :: PromptSpecification
promptSpecification = PromptSpecification
pPromptSpecification_
      }

-- | Undocumented member.
subSlotValueElicitationSetting_defaultValueSpecification :: Lens.Lens' SubSlotValueElicitationSetting (Prelude.Maybe SlotDefaultValueSpecification)
subSlotValueElicitationSetting_defaultValueSpecification :: Lens'
  SubSlotValueElicitationSetting
  (Maybe SlotDefaultValueSpecification)
subSlotValueElicitationSetting_defaultValueSpecification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SubSlotValueElicitationSetting' {Maybe SlotDefaultValueSpecification
defaultValueSpecification :: Maybe SlotDefaultValueSpecification
$sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe SlotDefaultValueSpecification
defaultValueSpecification} -> Maybe SlotDefaultValueSpecification
defaultValueSpecification) (\s :: SubSlotValueElicitationSetting
s@SubSlotValueElicitationSetting' {} Maybe SlotDefaultValueSpecification
a -> SubSlotValueElicitationSetting
s {$sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: Maybe SlotDefaultValueSpecification
defaultValueSpecification = Maybe SlotDefaultValueSpecification
a} :: SubSlotValueElicitationSetting)

-- | If you know a specific pattern that users might respond to an Amazon Lex
-- request for a sub slot value, you can provide those utterances to
-- improve accuracy. This is optional. In most cases Amazon Lex is capable
-- of understanding user utterances. This is similar to @SampleUtterances@
-- for slots.
subSlotValueElicitationSetting_sampleUtterances :: Lens.Lens' SubSlotValueElicitationSetting (Prelude.Maybe [SampleUtterance])
subSlotValueElicitationSetting_sampleUtterances :: Lens' SubSlotValueElicitationSetting (Maybe [SampleUtterance])
subSlotValueElicitationSetting_sampleUtterances = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SubSlotValueElicitationSetting' {Maybe [SampleUtterance]
sampleUtterances :: Maybe [SampleUtterance]
$sel:sampleUtterances:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> Maybe [SampleUtterance]
sampleUtterances} -> Maybe [SampleUtterance]
sampleUtterances) (\s :: SubSlotValueElicitationSetting
s@SubSlotValueElicitationSetting' {} Maybe [SampleUtterance]
a -> SubSlotValueElicitationSetting
s {$sel:sampleUtterances:SubSlotValueElicitationSetting' :: Maybe [SampleUtterance]
sampleUtterances = Maybe [SampleUtterance]
a} :: SubSlotValueElicitationSetting) 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

-- | Undocumented member.
subSlotValueElicitationSetting_waitAndContinueSpecification :: Lens.Lens' SubSlotValueElicitationSetting (Prelude.Maybe WaitAndContinueSpecification)
subSlotValueElicitationSetting_waitAndContinueSpecification :: Lens'
  SubSlotValueElicitationSetting (Maybe WaitAndContinueSpecification)
subSlotValueElicitationSetting_waitAndContinueSpecification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SubSlotValueElicitationSetting' {Maybe WaitAndContinueSpecification
waitAndContinueSpecification :: Maybe WaitAndContinueSpecification
$sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe WaitAndContinueSpecification
waitAndContinueSpecification} -> Maybe WaitAndContinueSpecification
waitAndContinueSpecification) (\s :: SubSlotValueElicitationSetting
s@SubSlotValueElicitationSetting' {} Maybe WaitAndContinueSpecification
a -> SubSlotValueElicitationSetting
s {$sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: Maybe WaitAndContinueSpecification
waitAndContinueSpecification = Maybe WaitAndContinueSpecification
a} :: SubSlotValueElicitationSetting)

-- | Undocumented member.
subSlotValueElicitationSetting_promptSpecification :: Lens.Lens' SubSlotValueElicitationSetting PromptSpecification
subSlotValueElicitationSetting_promptSpecification :: Lens' SubSlotValueElicitationSetting PromptSpecification
subSlotValueElicitationSetting_promptSpecification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SubSlotValueElicitationSetting' {PromptSpecification
promptSpecification :: PromptSpecification
$sel:promptSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> PromptSpecification
promptSpecification} -> PromptSpecification
promptSpecification) (\s :: SubSlotValueElicitationSetting
s@SubSlotValueElicitationSetting' {} PromptSpecification
a -> SubSlotValueElicitationSetting
s {$sel:promptSpecification:SubSlotValueElicitationSetting' :: PromptSpecification
promptSpecification = PromptSpecification
a} :: SubSlotValueElicitationSetting)

instance Data.FromJSON SubSlotValueElicitationSetting where
  parseJSON :: Value -> Parser SubSlotValueElicitationSetting
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SubSlotValueElicitationSetting"
      ( \Object
x ->
          Maybe SlotDefaultValueSpecification
-> Maybe [SampleUtterance]
-> Maybe WaitAndContinueSpecification
-> PromptSpecification
-> SubSlotValueElicitationSetting
SubSlotValueElicitationSetting'
            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
"defaultValueSpecification")
            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
"sampleUtterances"
                            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
"waitAndContinueSpecification")
            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
"promptSpecification")
      )

instance
  Prelude.Hashable
    SubSlotValueElicitationSetting
  where
  hashWithSalt :: Int -> SubSlotValueElicitationSetting -> Int
hashWithSalt
    Int
_salt
    SubSlotValueElicitationSetting' {Maybe [SampleUtterance]
Maybe SlotDefaultValueSpecification
Maybe WaitAndContinueSpecification
PromptSpecification
promptSpecification :: PromptSpecification
waitAndContinueSpecification :: Maybe WaitAndContinueSpecification
sampleUtterances :: Maybe [SampleUtterance]
defaultValueSpecification :: Maybe SlotDefaultValueSpecification
$sel:promptSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> PromptSpecification
$sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe WaitAndContinueSpecification
$sel:sampleUtterances:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> Maybe [SampleUtterance]
$sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe SlotDefaultValueSpecification
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SlotDefaultValueSpecification
defaultValueSpecification
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [SampleUtterance]
sampleUtterances
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe WaitAndContinueSpecification
waitAndContinueSpecification
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` PromptSpecification
promptSpecification

instance
  Prelude.NFData
    SubSlotValueElicitationSetting
  where
  rnf :: SubSlotValueElicitationSetting -> ()
rnf SubSlotValueElicitationSetting' {Maybe [SampleUtterance]
Maybe SlotDefaultValueSpecification
Maybe WaitAndContinueSpecification
PromptSpecification
promptSpecification :: PromptSpecification
waitAndContinueSpecification :: Maybe WaitAndContinueSpecification
sampleUtterances :: Maybe [SampleUtterance]
defaultValueSpecification :: Maybe SlotDefaultValueSpecification
$sel:promptSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> PromptSpecification
$sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe WaitAndContinueSpecification
$sel:sampleUtterances:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> Maybe [SampleUtterance]
$sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe SlotDefaultValueSpecification
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe SlotDefaultValueSpecification
defaultValueSpecification
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [SampleUtterance]
sampleUtterances
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe WaitAndContinueSpecification
waitAndContinueSpecification
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf PromptSpecification
promptSpecification

instance Data.ToJSON SubSlotValueElicitationSetting where
  toJSON :: SubSlotValueElicitationSetting -> Value
toJSON SubSlotValueElicitationSetting' {Maybe [SampleUtterance]
Maybe SlotDefaultValueSpecification
Maybe WaitAndContinueSpecification
PromptSpecification
promptSpecification :: PromptSpecification
waitAndContinueSpecification :: Maybe WaitAndContinueSpecification
sampleUtterances :: Maybe [SampleUtterance]
defaultValueSpecification :: Maybe SlotDefaultValueSpecification
$sel:promptSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> PromptSpecification
$sel:waitAndContinueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe WaitAndContinueSpecification
$sel:sampleUtterances:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting -> Maybe [SampleUtterance]
$sel:defaultValueSpecification:SubSlotValueElicitationSetting' :: SubSlotValueElicitationSetting
-> Maybe SlotDefaultValueSpecification
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"defaultValueSpecification" 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 SlotDefaultValueSpecification
defaultValueSpecification,
            (Key
"sampleUtterances" 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 [SampleUtterance]
sampleUtterances,
            (Key
"waitAndContinueSpecification" 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 WaitAndContinueSpecification
waitAndContinueSpecification,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"promptSpecification" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= PromptSpecification
promptSpecification)
          ]
      )