Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- ChannelStatus
- ChannelType
- ContentType
- ExportStatus
- ExportType
- FulfillmentActivityType
- ImportStatus
- LexStatus
- Locale
- MergeStrategy
- ProcessBehavior
- ResourceType
- SlotConstraint
- SlotValueSelectionStrategy
- StatusType
- BotAliasMetadata
- BotChannelAssociation
- BotMetadata
- BuiltinIntentMetadata
- BuiltinIntentSlot
- BuiltinSlotTypeMetadata
- CodeHook
- EnumerationValue
- FollowUpPrompt
- FulfillmentActivity
- Intent
- IntentMetadata
- Message
- Prompt
- Slot
- SlotTypeMetadata
- Statement
- UtteranceData
- UtteranceList
- lexModels :: Service
- _PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data ChannelStatus
- = Created
- | Failed
- | InProgress
- data ChannelType
- data ContentType
- data ExportStatus
- data ExportType
- data FulfillmentActivityType
- data ImportStatus
- data LexStatus
- data Locale
- data MergeStrategy
- data ProcessBehavior
- data ResourceType
- data SlotConstraint
- data SlotValueSelectionStrategy
- data StatusType
- data BotAliasMetadata
- botAliasMetadata :: BotAliasMetadata
- bamChecksum :: Lens' BotAliasMetadata (Maybe Text)
- bamBotVersion :: Lens' BotAliasMetadata (Maybe Text)
- bamBotName :: Lens' BotAliasMetadata (Maybe Text)
- bamCreatedDate :: Lens' BotAliasMetadata (Maybe UTCTime)
- bamName :: Lens' BotAliasMetadata (Maybe Text)
- bamLastUpdatedDate :: Lens' BotAliasMetadata (Maybe UTCTime)
- bamDescription :: Lens' BotAliasMetadata (Maybe Text)
- data BotChannelAssociation
- botChannelAssociation :: BotChannelAssociation
- bcaFailureReason :: Lens' BotChannelAssociation (Maybe Text)
- bcaStatus :: Lens' BotChannelAssociation (Maybe ChannelStatus)
- bcaBotAlias :: Lens' BotChannelAssociation (Maybe Text)
- bcaBotName :: Lens' BotChannelAssociation (Maybe Text)
- bcaBotConfiguration :: Lens' BotChannelAssociation (Maybe (HashMap Text Text))
- bcaCreatedDate :: Lens' BotChannelAssociation (Maybe UTCTime)
- bcaName :: Lens' BotChannelAssociation (Maybe Text)
- bcaType :: Lens' BotChannelAssociation (Maybe ChannelType)
- bcaDescription :: Lens' BotChannelAssociation (Maybe Text)
- data BotMetadata
- botMetadata :: BotMetadata
- bmStatus :: Lens' BotMetadata (Maybe LexStatus)
- bmCreatedDate :: Lens' BotMetadata (Maybe UTCTime)
- bmName :: Lens' BotMetadata (Maybe Text)
- bmVersion :: Lens' BotMetadata (Maybe Text)
- bmLastUpdatedDate :: Lens' BotMetadata (Maybe UTCTime)
- bmDescription :: Lens' BotMetadata (Maybe Text)
- data BuiltinIntentMetadata
- builtinIntentMetadata :: BuiltinIntentMetadata
- bimSignature :: Lens' BuiltinIntentMetadata (Maybe Text)
- bimSupportedLocales :: Lens' BuiltinIntentMetadata [Locale]
- data BuiltinIntentSlot
- builtinIntentSlot :: BuiltinIntentSlot
- bisName :: Lens' BuiltinIntentSlot (Maybe Text)
- data BuiltinSlotTypeMetadata
- builtinSlotTypeMetadata :: BuiltinSlotTypeMetadata
- bstmSignature :: Lens' BuiltinSlotTypeMetadata (Maybe Text)
- bstmSupportedLocales :: Lens' BuiltinSlotTypeMetadata [Locale]
- data CodeHook
- codeHook :: Text -> Text -> CodeHook
- chUri :: Lens' CodeHook Text
- chMessageVersion :: Lens' CodeHook Text
- data EnumerationValue
- enumerationValue :: Text -> EnumerationValue
- evSynonyms :: Lens' EnumerationValue [Text]
- evValue :: Lens' EnumerationValue Text
- data FollowUpPrompt
- followUpPrompt :: Prompt -> Statement -> FollowUpPrompt
- fupPrompt :: Lens' FollowUpPrompt Prompt
- fupRejectionStatement :: Lens' FollowUpPrompt Statement
- data FulfillmentActivity
- fulfillmentActivity :: FulfillmentActivityType -> FulfillmentActivity
- faCodeHook :: Lens' FulfillmentActivity (Maybe CodeHook)
- faType :: Lens' FulfillmentActivity FulfillmentActivityType
- data Intent
- intent :: Text -> Text -> Intent
- iIntentName :: Lens' Intent Text
- iIntentVersion :: Lens' Intent Text
- data IntentMetadata
- intentMetadata :: IntentMetadata
- imCreatedDate :: Lens' IntentMetadata (Maybe UTCTime)
- imName :: Lens' IntentMetadata (Maybe Text)
- imVersion :: Lens' IntentMetadata (Maybe Text)
- imLastUpdatedDate :: Lens' IntentMetadata (Maybe UTCTime)
- imDescription :: Lens' IntentMetadata (Maybe Text)
- data Message
- message :: ContentType -> Text -> Message
- mGroupNumber :: Lens' Message (Maybe Natural)
- mContentType :: Lens' Message ContentType
- mContent :: Lens' Message Text
- data Prompt
- prompt :: NonEmpty Message -> Natural -> Prompt
- pResponseCard :: Lens' Prompt (Maybe Text)
- pMessages :: Lens' Prompt (NonEmpty Message)
- pMaxAttempts :: Lens' Prompt Natural
- data Slot
- slot :: Text -> SlotConstraint -> Slot
- sSlotType :: Lens' Slot (Maybe Text)
- sValueElicitationPrompt :: Lens' Slot (Maybe Prompt)
- sResponseCard :: Lens' Slot (Maybe Text)
- sPriority :: Lens' Slot (Maybe Natural)
- sSlotTypeVersion :: Lens' Slot (Maybe Text)
- sSampleUtterances :: Lens' Slot [Text]
- sDescription :: Lens' Slot (Maybe Text)
- sName :: Lens' Slot Text
- sSlotConstraint :: Lens' Slot SlotConstraint
- data SlotTypeMetadata
- slotTypeMetadata :: SlotTypeMetadata
- stmCreatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime)
- stmName :: Lens' SlotTypeMetadata (Maybe Text)
- stmVersion :: Lens' SlotTypeMetadata (Maybe Text)
- stmLastUpdatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime)
- stmDescription :: Lens' SlotTypeMetadata (Maybe Text)
- data Statement
- statement :: NonEmpty Message -> Statement
- staResponseCard :: Lens' Statement (Maybe Text)
- staMessages :: Lens' Statement (NonEmpty Message)
- data UtteranceData
- utteranceData :: UtteranceData
- udFirstUtteredDate :: Lens' UtteranceData (Maybe UTCTime)
- udCount :: Lens' UtteranceData (Maybe Int)
- udUtteranceString :: Lens' UtteranceData (Maybe Text)
- udLastUtteredDate :: Lens' UtteranceData (Maybe UTCTime)
- udDistinctUsers :: Lens' UtteranceData (Maybe Int)
- data UtteranceList
- utteranceList :: UtteranceList
- ulBotVersion :: Lens' UtteranceList (Maybe Text)
- ulUtterances :: Lens' UtteranceList [UtteranceData]
Service Configuration
API version 2017-04-19
of the Amazon Lex Model Building Service SDK configuration.
Errors
_PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a conflict processing the request. Try your request again.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request was not found. Check the resource and try again.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal Amazon Lex error occurred. Try your request again.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded a limit. Try your request again.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string , "version": string } }
ChannelStatus
data ChannelStatus Source #
ChannelType
data ChannelType Source #
ContentType
data ContentType Source #
ExportStatus
data ExportStatus Source #
ExportType
data ExportType Source #
FulfillmentActivityType
data FulfillmentActivityType Source #
ImportStatus
data ImportStatus Source #
LexStatus
Locale
MergeStrategy
data MergeStrategy Source #
ProcessBehavior
data ProcessBehavior Source #
ResourceType
data ResourceType Source #
SlotConstraint
data SlotConstraint Source #
SlotValueSelectionStrategy
data SlotValueSelectionStrategy Source #
StatusType
data StatusType Source #
BotAliasMetadata
data BotAliasMetadata Source #
Provides information about a bot alias.
See: botAliasMetadata
smart constructor.
botAliasMetadata :: BotAliasMetadata Source #
Creates a value of BotAliasMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bamChecksum
- Checksum of the bot alias.bamBotVersion
- The version of the Amazon Lex bot to which the alias points.bamBotName
- The name of the bot to which the alias points.bamCreatedDate
- The date that the bot alias was created.bamName
- The name of the bot alias.bamLastUpdatedDate
- The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.bamDescription
- A description of the bot alias.
bamChecksum :: Lens' BotAliasMetadata (Maybe Text) Source #
Checksum of the bot alias.
bamBotVersion :: Lens' BotAliasMetadata (Maybe Text) Source #
The version of the Amazon Lex bot to which the alias points.
bamBotName :: Lens' BotAliasMetadata (Maybe Text) Source #
The name of the bot to which the alias points.
bamCreatedDate :: Lens' BotAliasMetadata (Maybe UTCTime) Source #
The date that the bot alias was created.
bamLastUpdatedDate :: Lens' BotAliasMetadata (Maybe UTCTime) Source #
The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
bamDescription :: Lens' BotAliasMetadata (Maybe Text) Source #
A description of the bot alias.
BotChannelAssociation
data BotChannelAssociation Source #
Represents an association between an Amazon Lex bot and an external messaging platform.
See: botChannelAssociation
smart constructor.
botChannelAssociation :: BotChannelAssociation Source #
Creates a value of BotChannelAssociation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcaFailureReason
- Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to create the association.bcaStatus
- The status of the bot channel. *CREATED
- The channel has been created and is ready for use. *IN_PROGRESS
- Channel creation is in progress. *FAILED
- There was an error creating the channel. For information about the reason for the failure, see thefailureReason
field.bcaBotAlias
- An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.bcaBotName
- The name of the Amazon Lex bot to which this association is being made.bcaBotConfiguration
- Provides information necessary to communicate with the messaging platform.bcaCreatedDate
- The date that the association between the Amazon Lex bot and the channel was created.bcaName
- The name of the association between the bot and the channel.bcaType
- Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.bcaDescription
- A text description of the association you are creating.
bcaFailureReason :: Lens' BotChannelAssociation (Maybe Text) Source #
If status
is FAILED
, Amazon Lex provides the reason that it failed to create the association.
bcaStatus :: Lens' BotChannelAssociation (Maybe ChannelStatus) Source #
The status of the bot channel. * CREATED
- The channel has been created and is ready for use. * IN_PROGRESS
- Channel creation is in progress. * FAILED
- There was an error creating the channel. For information about the reason for the failure, see the failureReason
field.
bcaBotAlias :: Lens' BotChannelAssociation (Maybe Text) Source #
An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
bcaBotName :: Lens' BotChannelAssociation (Maybe Text) Source #
The name of the Amazon Lex bot to which this association is being made.
bcaBotConfiguration :: Lens' BotChannelAssociation (Maybe (HashMap Text Text)) Source #
Provides information necessary to communicate with the messaging platform.
bcaCreatedDate :: Lens' BotChannelAssociation (Maybe UTCTime) Source #
The date that the association between the Amazon Lex bot and the channel was created.
bcaName :: Lens' BotChannelAssociation (Maybe Text) Source #
The name of the association between the bot and the channel.
bcaType :: Lens' BotChannelAssociation (Maybe ChannelType) Source #
Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
bcaDescription :: Lens' BotChannelAssociation (Maybe Text) Source #
A text description of the association you are creating.
BotMetadata
data BotMetadata Source #
Provides information about a bot. .
See: botMetadata
smart constructor.
botMetadata :: BotMetadata Source #
Creates a value of BotMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bmStatus
- The status of the bot.bmCreatedDate
- The date that the bot was created.bmName
- The name of the bot.bmVersion
- The version of the bot. For a new bot, the version is always> LATEST
.bmLastUpdatedDate
- The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.bmDescription
- A description of the bot.
bmCreatedDate :: Lens' BotMetadata (Maybe UTCTime) Source #
The date that the bot was created.
bmVersion :: Lens' BotMetadata (Maybe Text) Source #
The version of the bot. For a new bot, the version is always > LATEST
.
bmLastUpdatedDate :: Lens' BotMetadata (Maybe UTCTime) Source #
The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
bmDescription :: Lens' BotMetadata (Maybe Text) Source #
A description of the bot.
BuiltinIntentMetadata
data BuiltinIntentMetadata Source #
Provides metadata for a built-in intent.
See: builtinIntentMetadata
smart constructor.
builtinIntentMetadata :: BuiltinIntentMetadata Source #
Creates a value of BuiltinIntentMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bimSignature
- A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .bimSupportedLocales
- A list of identifiers for the locales that the intent supports.
bimSignature :: Lens' BuiltinIntentMetadata (Maybe Text) Source #
A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit .
bimSupportedLocales :: Lens' BuiltinIntentMetadata [Locale] Source #
A list of identifiers for the locales that the intent supports.
BuiltinIntentSlot
data BuiltinIntentSlot Source #
Provides information about a slot used in a built-in intent.
See: builtinIntentSlot
smart constructor.
builtinIntentSlot :: BuiltinIntentSlot Source #
Creates a value of BuiltinIntentSlot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bisName
- A list of the slots defined for the intent.
BuiltinSlotTypeMetadata
data BuiltinSlotTypeMetadata Source #
Provides information about a built in slot type.
See: builtinSlotTypeMetadata
smart constructor.
builtinSlotTypeMetadata :: BuiltinSlotTypeMetadata Source #
Creates a value of BuiltinSlotTypeMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bstmSignature
- A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit .bstmSupportedLocales
- A list of target locales for the slot.
bstmSignature :: Lens' BuiltinSlotTypeMetadata (Maybe Text) Source #
A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit .
bstmSupportedLocales :: Lens' BuiltinSlotTypeMetadata [Locale] Source #
A list of target locales for the slot.
CodeHook
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..
See: codeHook
smart constructor.
Creates a value of CodeHook
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
chUri
- The Amazon Resource Name (ARN) of the Lambda function.chMessageVersion
- The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see 'using-lambda' .
chMessageVersion :: Lens' CodeHook Text Source #
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see 'using-lambda' .
EnumerationValue
data EnumerationValue Source #
Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
- thick
- thin
- stuffed
See: enumerationValue
smart constructor.
Creates a value of EnumerationValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evSynonyms
- Additional values related to the slot type value.evValue
- The value of the slot type.
evSynonyms :: Lens' EnumerationValue [Text] Source #
Additional values related to the slot type value.
FollowUpPrompt
data FollowUpPrompt Source #
A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza
intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.
See: followUpPrompt
smart constructor.
Creates a value of FollowUpPrompt
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fupPrompt
- Prompts for information from the user.fupRejectionStatement
- If the user answers "no" to the question defined in theprompt
field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
fupRejectionStatement :: Lens' FollowUpPrompt Statement Source #
If the user answers "no" to the question defined in the prompt
field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
FulfillmentActivity
data FulfillmentActivity Source #
Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.
Consider the following examples:
- In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.
- In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.
See: fulfillmentActivity
smart constructor.
Creates a value of FulfillmentActivity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
faCodeHook
- A description of the Lambda function that is run to fulfill the intent.faType
- How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
faCodeHook :: Lens' FulfillmentActivity (Maybe CodeHook) Source #
A description of the Lambda function that is run to fulfill the intent.
faType :: Lens' FulfillmentActivity FulfillmentActivityType Source #
How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
Intent
Identifies the specific version of an intent.
See: intent
smart constructor.
Creates a value of Intent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iIntentName
- The name of the intent.iIntentVersion
- The version of the intent.
IntentMetadata
data IntentMetadata Source #
Provides information about an intent.
See: intentMetadata
smart constructor.
intentMetadata :: IntentMetadata Source #
Creates a value of IntentMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
imCreatedDate
- The date that the intent was created.imName
- The name of the intent.imVersion
- The version of the intent.imLastUpdatedDate
- The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.imDescription
- A description of the intent.
imCreatedDate :: Lens' IntentMetadata (Maybe UTCTime) Source #
The date that the intent was created.
imLastUpdatedDate :: Lens' IntentMetadata (Maybe UTCTime) Source #
The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
imDescription :: Lens' IntentMetadata (Maybe Text) Source #
A description of the intent.
Message
The message object that provides the message text and its type.
See: message
smart constructor.
Creates a value of Message
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mGroupNumber
- Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.mContentType
- The content type of the message string.mContent
- The text of the message.
mGroupNumber :: Lens' Message (Maybe Natural) Source #
Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.
mContentType :: Lens' Message ContentType Source #
The content type of the message string.
Prompt
Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see 'how-it-works' .
See: prompt
smart constructor.
Creates a value of Prompt
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pResponseCard
- A response card. Amazon Lex uses this prompt at runtime, in thePostText
API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see 'ex-resp-card' .pMessages
- An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).pMaxAttempts
- The number of times to prompt the user for information.
pResponseCard :: Lens' Prompt (Maybe Text) Source #
A response card. Amazon Lex uses this prompt at runtime, in the PostText
API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see 'ex-resp-card' .
pMessages :: Lens' Prompt (NonEmpty Message) Source #
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
pMaxAttempts :: Lens' Prompt Natural Source #
The number of times to prompt the user for information.
Slot
Identifies the version of a specific slot.
See: slot
smart constructor.
Creates a value of Slot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sSlotType
- The type of the slot, either a custom slot type that you defined or one of the built-in slot types.sValueElicitationPrompt
- The prompt that Amazon Lex uses to elicit the slot value from the user.sResponseCard
- A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.sPriority
- Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.sSlotTypeVersion
- The version of the slot type.sSampleUtterances
- If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.sDescription
- A description of the slot.sName
- The name of the slot.sSlotConstraint
- Specifies whether the slot is required or optional.
sSlotType :: Lens' Slot (Maybe Text) Source #
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
sValueElicitationPrompt :: Lens' Slot (Maybe Prompt) Source #
The prompt that Amazon Lex uses to elicit the slot value from the user.
sResponseCard :: Lens' Slot (Maybe Text) Source #
A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
sPriority :: Lens' Slot (Maybe Natural) Source #
Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.
sSampleUtterances :: Lens' Slot [Text] Source #
If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
sSlotConstraint :: Lens' Slot SlotConstraint Source #
Specifies whether the slot is required or optional.
SlotTypeMetadata
data SlotTypeMetadata Source #
Provides information about a slot type..
See: slotTypeMetadata
smart constructor.
slotTypeMetadata :: SlotTypeMetadata Source #
Creates a value of SlotTypeMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stmCreatedDate
- The date that the slot type was created.stmName
- The name of the slot type.stmVersion
- The version of the slot type.stmLastUpdatedDate
- The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.stmDescription
- A description of the slot type.
stmCreatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime) Source #
The date that the slot type was created.
stmVersion :: Lens' SlotTypeMetadata (Maybe Text) Source #
The version of the slot type.
stmLastUpdatedDate :: Lens' SlotTypeMetadata (Maybe UTCTime) Source #
The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
stmDescription :: Lens' SlotTypeMetadata (Maybe Text) Source #
A description of the slot type.
Statement
A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
See: statement
smart constructor.
Creates a value of Statement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
staResponseCard
- At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.staMessages
- A collection of message objects.
staResponseCard :: Lens' Statement (Maybe Text) Source #
At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.
UtteranceData
data UtteranceData Source #
Provides information about a single utterance that was made to your bot.
See: utteranceData
smart constructor.
utteranceData :: UtteranceData Source #
Creates a value of UtteranceData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udFirstUtteredDate
- The date that the utterance was first recorded.udCount
- The number of times that the utterance was processed.udUtteranceString
- The text that was entered by the user or the text representation of an audio clip.udLastUtteredDate
- The date that the utterance was last recorded.udDistinctUsers
- The total number of individuals that used the utterance.
udFirstUtteredDate :: Lens' UtteranceData (Maybe UTCTime) Source #
The date that the utterance was first recorded.
udCount :: Lens' UtteranceData (Maybe Int) Source #
The number of times that the utterance was processed.
udUtteranceString :: Lens' UtteranceData (Maybe Text) Source #
The text that was entered by the user or the text representation of an audio clip.
udLastUtteredDate :: Lens' UtteranceData (Maybe UTCTime) Source #
The date that the utterance was last recorded.
udDistinctUsers :: Lens' UtteranceData (Maybe Int) Source #
The total number of individuals that used the utterance.
UtteranceList
data UtteranceList Source #
Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.
See: utteranceList
smart constructor.
utteranceList :: UtteranceList Source #
Creates a value of UtteranceList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ulBotVersion
- The version of the bot that processed the list.ulUtterances
- One or moreUtteranceData
objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
ulBotVersion :: Lens' UtteranceList (Maybe Text) Source #
The version of the bot that processed the list.
ulUtterances :: Lens' UtteranceList [UtteranceData] Source #
One or more UtteranceData
objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.