Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LexV2Models.CreateBotLocale

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

Synopsis

data CreateBotLocale = CreateBotLocale' {
- description :: Maybe Text
- voiceSettings :: Maybe VoiceSettings
- botId :: Text
- botVersion :: Text
- localeId :: Text
- nluIntentConfidenceThreshold :: Double
}
newCreateBotLocale :: Text -> Text -> Text -> Double -> CreateBotLocale
createBotLocale_description :: Lens' CreateBotLocale (Maybe Text)
createBotLocale_voiceSettings :: Lens' CreateBotLocale (Maybe VoiceSettings)
createBotLocale_botId :: Lens' CreateBotLocale Text
createBotLocale_botVersion :: Lens' CreateBotLocale Text
createBotLocale_localeId :: Lens' CreateBotLocale Text
createBotLocale_nluIntentConfidenceThreshold :: Lens' CreateBotLocale Double
data CreateBotLocaleResponse = CreateBotLocaleResponse' {
- botId :: Maybe Text
- botLocaleStatus :: Maybe BotLocaleStatus
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- localeId :: Maybe Text
- localeName :: Maybe Text
- nluIntentConfidenceThreshold :: Maybe Double
- voiceSettings :: Maybe VoiceSettings
- httpStatus :: Int
}
newCreateBotLocaleResponse :: Int -> CreateBotLocaleResponse
createBotLocaleResponse_botId :: Lens' CreateBotLocaleResponse (Maybe Text)
createBotLocaleResponse_botLocaleStatus :: Lens' CreateBotLocaleResponse (Maybe BotLocaleStatus)
createBotLocaleResponse_botVersion :: Lens' CreateBotLocaleResponse (Maybe Text)
createBotLocaleResponse_creationDateTime :: Lens' CreateBotLocaleResponse (Maybe UTCTime)
createBotLocaleResponse_description :: Lens' CreateBotLocaleResponse (Maybe Text)
createBotLocaleResponse_localeId :: Lens' CreateBotLocaleResponse (Maybe Text)
createBotLocaleResponse_localeName :: Lens' CreateBotLocaleResponse (Maybe Text)
createBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' CreateBotLocaleResponse (Maybe Double)
createBotLocaleResponse_voiceSettings :: Lens' CreateBotLocaleResponse (Maybe VoiceSettings)
createBotLocaleResponse_httpStatus :: Lens' CreateBotLocaleResponse Int

Creating a Request

data CreateBotLocale Source #

See: newCreateBotLocale smart constructor.

Constructors

CreateBotLocale'

Fields

description :: Maybe Text
A description of the bot locale. Use this to help identify the bot locale in lists.
voiceSettings :: Maybe VoiceSettings
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
botId :: Text
The identifier of the bot to create the locale for.
botVersion :: Text
The version of the bot to create the locale for. This can only be the draft version of the bot.
localeId :: Text
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold :: Double
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:
- AMAZON.FallbackIntent
- IntentA
- IntentB
- IntentC

Instances

Instances details

ToJSON CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods toJSON :: CreateBotLocale -> Value # toEncoding :: CreateBotLocale -> Encoding # toJSONList :: [CreateBotLocale] -> Value # toEncodingList :: [CreateBotLocale] -> Encoding #
ToHeaders CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods toHeaders :: CreateBotLocale -> [Header] #
ToPath CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods toPath :: CreateBotLocale -> ByteString #
ToQuery CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods toQuery :: CreateBotLocale -> QueryString #
AWSRequest CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Associated Types type AWSResponse CreateBotLocale # Methods request :: (Service -> Service) -> CreateBotLocale -> Request CreateBotLocale # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBotLocale -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBotLocale))) #
Generic CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Associated Types type Rep CreateBotLocale :: Type -> Type # Methods from :: CreateBotLocale -> Rep CreateBotLocale x # to :: Rep CreateBotLocale x -> CreateBotLocale #
Read CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods readsPrec :: Int -> ReadS CreateBotLocale # readList :: ReadS [CreateBotLocale] # readPrec :: ReadPrec CreateBotLocale # readListPrec :: ReadPrec [CreateBotLocale] #
Show CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods showsPrec :: Int -> CreateBotLocale -> ShowS # show :: CreateBotLocale -> String # showList :: [CreateBotLocale] -> ShowS #
NFData CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods rnf :: CreateBotLocale -> () #
Eq CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods (==) :: CreateBotLocale -> CreateBotLocale -> Bool # (/=) :: CreateBotLocale -> CreateBotLocale -> Bool #
Hashable CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods hashWithSalt :: Int -> CreateBotLocale -> Int # hash :: CreateBotLocale -> Int #
type AWSResponse CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale type AWSResponse CreateBotLocale = CreateBotLocaleResponse
type Rep CreateBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale type Rep CreateBotLocale = D1 ('MetaData "CreateBotLocale" "Amazonka.LexV2Models.CreateBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateBotLocale'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "voiceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceSettings)) :: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nluIntentConfidenceThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))))

newCreateBotLocale Source #

Arguments

:: Text	`CreateBotLocale`
-> Text	`CreateBotLocale`
-> Text	`CreateBotLocale`
-> Double	`CreateBotLocale`
-> CreateBotLocale

Create a value of CreateBotLocale with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateBotLocale, createBotLocale_description - A description of the bot locale. Use this to help identify the bot locale in lists.

CreateBotLocale, createBotLocale_voiceSettings - The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

CreateBotLocale, createBotLocale_botId - The identifier of the bot to create the locale for.

CreateBotLocale, createBotLocale_botVersion - The version of the bot to create the locale for. This can only be the draft version of the bot.

CreateBotLocale, createBotLocale_localeId - The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

CreateBotLocale, createBotLocale_nluIntentConfidenceThreshold - Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

AMAZON.FallbackIntent
IntentA
IntentB
IntentC

Request Lenses

createBotLocale_description :: Lens' CreateBotLocale (Maybe Text) Source #

A description of the bot locale. Use this to help identify the bot locale in lists.

createBotLocale_voiceSettings :: Lens' CreateBotLocale (Maybe VoiceSettings) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

createBotLocale_botId :: Lens' CreateBotLocale Text Source #

The identifier of the bot to create the locale for.

createBotLocale_botVersion :: Lens' CreateBotLocale Text Source #

The version of the bot to create the locale for. This can only be the draft version of the bot.

createBotLocale_localeId :: Lens' CreateBotLocale Text Source #

The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

createBotLocale_nluIntentConfidenceThreshold :: Lens' CreateBotLocale Double Source #

Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

AMAZON.FallbackIntent
IntentA
IntentB
IntentC

Destructuring the Response

data CreateBotLocaleResponse Source #

See: newCreateBotLocaleResponse smart constructor.

Constructors

CreateBotLocaleResponse'

Fields

botId :: Maybe Text
The specified bot identifier.
botLocaleStatus :: Maybe BotLocaleStatus
The status of the bot.
When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.
If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.
If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.
botVersion :: Maybe Text
The specified bot version.
creationDateTime :: Maybe POSIX
A timestamp specifying the date and time that the bot locale was created.
description :: Maybe Text
The specified description of the bot locale.
localeId :: Maybe Text
The specified locale identifier.
localeName :: Maybe Text
The specified locale name.
nluIntentConfidenceThreshold :: Maybe Double
The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.
voiceSettings :: Maybe VoiceSettings
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Associated Types type Rep CreateBotLocaleResponse :: Type -> Type # Methods from :: CreateBotLocaleResponse -> Rep CreateBotLocaleResponse x # to :: Rep CreateBotLocaleResponse x -> CreateBotLocaleResponse #
Read CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods readsPrec :: Int -> ReadS CreateBotLocaleResponse # readList :: ReadS [CreateBotLocaleResponse] # readPrec :: ReadPrec CreateBotLocaleResponse # readListPrec :: ReadPrec [CreateBotLocaleResponse] #
Show CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods showsPrec :: Int -> CreateBotLocaleResponse -> ShowS # show :: CreateBotLocaleResponse -> String # showList :: [CreateBotLocaleResponse] -> ShowS #
NFData CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods rnf :: CreateBotLocaleResponse -> () #
Eq CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale Methods (==) :: CreateBotLocaleResponse -> CreateBotLocaleResponse -> Bool # (/=) :: CreateBotLocaleResponse -> CreateBotLocaleResponse -> Bool #
type Rep CreateBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotLocale type Rep CreateBotLocaleResponse = D1 ('MetaData "CreateBotLocaleResponse" "Amazonka.LexV2Models.CreateBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateBotLocaleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botLocaleStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotLocaleStatus))) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "localeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nluIntentConfidenceThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "voiceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceSettings)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateBotLocaleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBotLocaleResponse'`
-> CreateBotLocaleResponse

Create a value of CreateBotLocaleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateBotLocale, createBotLocaleResponse_botId - The specified bot identifier.

CreateBotLocaleResponse, createBotLocaleResponse_botLocaleStatus - The status of the bot.

When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.

If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.

CreateBotLocale, createBotLocaleResponse_botVersion - The specified bot version.

CreateBotLocaleResponse, createBotLocaleResponse_creationDateTime - A timestamp specifying the date and time that the bot locale was created.

CreateBotLocale, createBotLocaleResponse_description - The specified description of the bot locale.

CreateBotLocale, createBotLocaleResponse_localeId - The specified locale identifier.

CreateBotLocaleResponse, createBotLocaleResponse_localeName - The specified locale name.

CreateBotLocale, createBotLocaleResponse_nluIntentConfidenceThreshold - The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

CreateBotLocale, createBotLocaleResponse_voiceSettings - The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

$sel:httpStatus:CreateBotLocaleResponse', createBotLocaleResponse_httpStatus - The response's http status code.

Response Lenses

createBotLocaleResponse_botId :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified bot identifier.

createBotLocaleResponse_botLocaleStatus :: Lens' CreateBotLocaleResponse (Maybe BotLocaleStatus) Source #

The status of the bot.

When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.

If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.

createBotLocaleResponse_botVersion :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified bot version.

createBotLocaleResponse_creationDateTime :: Lens' CreateBotLocaleResponse (Maybe UTCTime) Source #

A timestamp specifying the date and time that the bot locale was created.

createBotLocaleResponse_description :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified description of the bot locale.

createBotLocaleResponse_localeId :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified locale identifier.

createBotLocaleResponse_localeName :: Lens' CreateBotLocaleResponse (Maybe Text) Source #

The specified locale name.

createBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' CreateBotLocaleResponse (Maybe Double) Source #

The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

createBotLocaleResponse_voiceSettings :: Lens' CreateBotLocaleResponse (Maybe VoiceSettings) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

createBotLocaleResponse_httpStatus :: Lens' CreateBotLocaleResponse Int Source #

The response's http status code.