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 |
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' {}
- 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' {}
- 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.
CreateBotLocale' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> Double | |
-> 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.
CreateBotLocaleResponse' | |
|
Instances
newCreateBotLocaleResponse Source #
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.