2021/06/15 - Amazon Lex Model Building V2 - 3 updated api methods
{'multipleValuesSetting': {'allowMultipleValues': 'boolean'}}
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
See also: AWS API Documentation
Request Syntax
client.create_slot(
slotName='string',
description='string',
slotTypeId='string',
valueElicitationSetting={
'defaultValueSpecification': {
'defaultValueList': [
{
'defaultValue': 'string'
},
]
},
'slotConstraint': 'Required'|'Optional',
'promptSpecification': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'maxRetries': 123,
'allowInterrupt': True|False
},
'sampleUtterances': [
{
'utterance': 'string'
},
],
'waitAndContinueSpecification': {
'waitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'continueResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'stillWaitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'frequencyInSeconds': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
}
}
},
obfuscationSetting={
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
botId='string',
botVersion='string',
localeId='string',
intentId='string',
multipleValuesSetting={
'allowMultipleValues': True|False
}
)
string
[REQUIRED]
The name of the slot. Slot names must be unique within the bot that contains the slot.
string
A description of the slot. Use this to help identify the slot in lists.
string
[REQUIRED]
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
dict
[REQUIRED]
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
defaultValueSpecification (dict) --
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
defaultValueList (list) -- [REQUIRED]
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) -- [REQUIRED]
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) -- [REQUIRED]
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries (integer) -- [REQUIRED]
The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech prompt from the bot.
sampleUtterances (list) --
If you know a specific pattern that 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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse (dict) --
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups (list) -- [REQUIRED]
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds (integer) -- [REQUIRED]
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) -- [REQUIRED]
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt (boolean) --
Indicates that the user can interrupt the response by speaking while the message is being played.
dict
Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
obfuscationSettingType (string) -- [REQUIRED]
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
string
[REQUIRED]
The identifier of the bot associated with the slot.
string
[REQUIRED]
The version of the bot associated with the slot.
string
[REQUIRED]
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the multipleValuesSetting is not set, the default value is false.
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'defaultValueSpecification': {
'defaultValueList': [
{
'defaultValue': 'string'
},
]
},
'slotConstraint': 'Required'|'Optional',
'promptSpecification': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'maxRetries': 123,
'allowInterrupt': True|False
},
'sampleUtterances': [
{
'utterance': 'string'
},
],
'waitAndContinueSpecification': {
'waitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'continueResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'stillWaitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'frequencyInSeconds': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
}
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
slotId (string) --
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
slotName (string) --
The name specified for the slot.
description (string) --
The description associated with the slot.
slotTypeId (string) --
The unique identifier of the slot type associated with this slot.
valueElicitationSetting (dict) --
The value elicitation settings specified for the slot.
defaultValueSpecification (dict) --
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
defaultValueList (list) --
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) --
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries (integer) --
The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech prompt from the bot.
sampleUtterances (list) --
If you know a specific pattern that 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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) --
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse (dict) --
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups (list) --
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds (integer) --
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) --
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt (boolean) --
Indicates that the user can interrupt the response by speaking while the message is being played.
obfuscationSetting (dict) --
Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
obfuscationSettingType (string) --
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
botId (string) --
The unique identifier of the bot associated with the slot.
botVersion (string) --
The version of the bot associated with the slot.
localeId (string) --
The language and local specified for the slot.
intentId (string) --
The unique identifier of the intent associated with the slot.
creationDateTime (datetime) --
The timestamp of the date and time that the slot was created.
multipleValuesSetting (dict) --
Indicates whether the slot returns multiple values in one response.
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.
{'multipleValuesSetting': {'allowMultipleValues': 'boolean'}}
Gets metadata information about a slot.
See also: AWS API Documentation
Request Syntax
client.describe_slot(
slotId='string',
botId='string',
botVersion='string',
localeId='string',
intentId='string'
)
string
[REQUIRED]
The unique identifier for the slot.
string
[REQUIRED]
The identifier of the bot associated with the slot.
string
[REQUIRED]
The version of the bot associated with the slot.
string
[REQUIRED]
The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'defaultValueSpecification': {
'defaultValueList': [
{
'defaultValue': 'string'
},
]
},
'slotConstraint': 'Required'|'Optional',
'promptSpecification': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'maxRetries': 123,
'allowInterrupt': True|False
},
'sampleUtterances': [
{
'utterance': 'string'
},
],
'waitAndContinueSpecification': {
'waitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'continueResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'stillWaitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'frequencyInSeconds': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
}
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
slotId (string) --
The unique identifier generated for the slot.
slotName (string) --
The name specified for the slot.
description (string) --
The description specified for the slot.
slotTypeId (string) --
The identifier of the slot type that determines the values entered into the slot.
valueElicitationSetting (dict) --
Prompts that Amazon Lex uses to elicit a value for the slot.
defaultValueSpecification (dict) --
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
defaultValueList (list) --
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) --
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries (integer) --
The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech prompt from the bot.
sampleUtterances (list) --
If you know a specific pattern that 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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) --
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse (dict) --
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups (list) --
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds (integer) --
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) --
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt (boolean) --
Indicates that the user can interrupt the response by speaking while the message is being played.
obfuscationSetting (dict) --
Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.
obfuscationSettingType (string) --
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
botId (string) --
The identifier of the bot associated with the slot.
botVersion (string) --
The version of the bot associated with the slot.
localeId (string) --
The language and locale specified for the slot.
intentId (string) --
The identifier of the intent associated with the slot.
creationDateTime (datetime) --
A timestamp of the date and time that the slot was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the slot was last updated.
multipleValuesSetting (dict) --
Indicates whether the slot accepts multiple values in a single utterance.
If the multipleValuesSetting is not set, the default value is false.
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.
{'multipleValuesSetting': {'allowMultipleValues': 'boolean'}}
Updates the settings for a slot.
See also: AWS API Documentation
Request Syntax
client.update_slot(
slotId='string',
slotName='string',
description='string',
slotTypeId='string',
valueElicitationSetting={
'defaultValueSpecification': {
'defaultValueList': [
{
'defaultValue': 'string'
},
]
},
'slotConstraint': 'Required'|'Optional',
'promptSpecification': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'maxRetries': 123,
'allowInterrupt': True|False
},
'sampleUtterances': [
{
'utterance': 'string'
},
],
'waitAndContinueSpecification': {
'waitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'continueResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'stillWaitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'frequencyInSeconds': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
}
}
},
obfuscationSetting={
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
botId='string',
botVersion='string',
localeId='string',
intentId='string',
multipleValuesSetting={
'allowMultipleValues': True|False
}
)
string
[REQUIRED]
The unique identifier for the slot to update.
string
[REQUIRED]
The new name for the slot.
string
The new description for the slot.
string
[REQUIRED]
The unique identifier of the new slot type to associate with this slot.
dict
[REQUIRED]
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
defaultValueSpecification (dict) --
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
defaultValueList (list) -- [REQUIRED]
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) -- [REQUIRED]
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) -- [REQUIRED]
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries (integer) -- [REQUIRED]
The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech prompt from the bot.
sampleUtterances (list) --
If you know a specific pattern that 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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse (dict) --
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups (list) -- [REQUIRED]
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds (integer) -- [REQUIRED]
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) -- [REQUIRED]
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt (boolean) --
Indicates that the user can interrupt the response by speaking while the message is being played.
dict
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
obfuscationSettingType (string) -- [REQUIRED]
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
string
[REQUIRED]
The unique identifier of the bot that contains the slot.
string
[REQUIRED]
The version of the bot that contains the slot. Must always be DRAFT.
string
[REQUIRED]
The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the multipleValuesSetting is not set, the default value is false.
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'defaultValueSpecification': {
'defaultValueList': [
{
'defaultValue': 'string'
},
]
},
'slotConstraint': 'Required'|'Optional',
'promptSpecification': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'maxRetries': 123,
'allowInterrupt': True|False
},
'sampleUtterances': [
{
'utterance': 'string'
},
],
'waitAndContinueSpecification': {
'waitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'continueResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'allowInterrupt': True|False
},
'stillWaitingResponse': {
'messageGroups': [
{
'message': {
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
'variations': [
{
'plainTextMessage': {
'value': 'string'
},
'customPayload': {
'value': 'string'
},
'ssmlMessage': {
'value': 'string'
},
'imageResponseCard': {
'title': 'string',
'subtitle': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
}
},
]
},
],
'frequencyInSeconds': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
}
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
slotId (string) --
The unique identifier of the slot that was updated.
slotName (string) --
The updated name of the slot.
description (string) --
The updated description of the bot.
slotTypeId (string) --
The updated identifier of the slot type that provides values for the slot.
valueElicitationSetting (dict) --
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
defaultValueSpecification (dict) --
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
defaultValueList (list) --
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) --
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) --
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries (integer) --
The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech prompt from the bot.
sampleUtterances (list) --
If you know a specific pattern that 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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) --
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse (dict) --
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt (boolean) --
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse (dict) --
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups (list) --
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations (list) --
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) --
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle (string) --
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl (string) --
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons (list) --
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) --
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) --
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds (integer) --
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) --
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt (boolean) --
Indicates that the user can interrupt the response by speaking while the message is being played.
obfuscationSetting (dict) --
The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
obfuscationSettingType (string) --
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
botId (string) --
The identifier of the bot that contains the slot.
botVersion (string) --
The identifier of the slot version that contains the slot. Will always be DRAFT.
localeId (string) --
The locale that contains the slot.
intentId (string) --
The intent that contains the slot.
creationDateTime (datetime) --
The timestamp of the date and time that the slot was created.
lastUpdatedDateTime (datetime) --
The timestamp of the date and time that the slot was last updated.
multipleValuesSetting (dict) --
Indicates whether the slot accepts multiple values in one response.
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.
Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the allowMutlipleValues is not set, the default value is false.