Class: AWS.LexModelsV2
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.LexModelsV2
- Identifier:
- lexmodelsv2
- API Version:
- 2020-08-07
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Sending a Request Using LexModelsV2
var lexmodelsv2 = new AWS.LexModelsV2();
lexmodelsv2.batchCreateCustomVocabularyItem(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the LexModelsV2 object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var lexmodelsv2 = new AWS.LexModelsV2({apiVersion: '2020-08-07'});
You can also set the API version globally in AWS.config.apiVersions
using
the lexmodelsv2 service identifier:
AWS.config.apiVersions = {
lexmodelsv2: '2020-08-07',
// other service API versions
};
var lexmodelsv2 = new AWS.LexModelsV2();
Version:
-
2020-08-07
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
botAvailable, botAliasAvailable, botExportCompleted, botImportCompleted, botLocaleBuilt, botLocaleExpressTestingAvailable, botVersionAvailable, botLocaleCreated
Constructor Summary collapse
-
new AWS.LexModelsV2(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
batchCreateCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
.
-
batchDeleteCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
.
-
batchUpdateCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
.
-
buildBotLocale(params = {}, callback) ⇒ AWS.Request
Builds a bot, its intents, and its slot types into a specific locale.
-
createBot(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lex conversational bot.
-
createBotAlias(params = {}, callback) ⇒ AWS.Request
Creates an alias for the specified version of a bot.
-
createBotLocale(params = {}, callback) ⇒ AWS.Request
Creates a locale in the bot.
-
createBotReplica(params = {}, callback) ⇒ AWS.Request
Action to create a replication of the source bot in the secondary region.
.
-
createBotVersion(params = {}, callback) ⇒ AWS.Request
Creates an immutable version of the bot.
-
createExport(params = {}, callback) ⇒ AWS.Request
Creates a zip archive containing the contents of a bot or a bot locale.
-
createIntent(params = {}, callback) ⇒ AWS.Request
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents.
-
createResourcePolicy(params = {}, callback) ⇒ AWS.Request
Creates a new resource policy with the specified policy statements.
.
-
createResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request
Adds a new resource policy statement to a bot or bot alias.
-
createSlot(params = {}, callback) ⇒ AWS.Request
Creates a slot in an intent.
-
createSlotType(params = {}, callback) ⇒ AWS.Request
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
-
createTestSetDiscrepancyReport(params = {}, callback) ⇒ AWS.Request
Create a report that describes the differences between the bot and the test set.
.
-
createUploadUrl(params = {}, callback) ⇒ AWS.Request
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
-
deleteBot(params = {}, callback) ⇒ AWS.Request
Deletes all versions of a bot, including the
Draft
version. -
deleteBotAlias(params = {}, callback) ⇒ AWS.Request
Deletes the specified bot alias.
.
-
deleteBotLocale(params = {}, callback) ⇒ AWS.Request
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
. -
deleteBotReplica(params = {}, callback) ⇒ AWS.Request
The action to delete the replicated bot in the secondary region.
.
-
deleteBotVersion(params = {}, callback) ⇒ AWS.Request
Deletes a specific version of a bot.
-
deleteCustomVocabulary(params = {}, callback) ⇒ AWS.Request
Removes a custom vocabulary from the specified locale in the specified bot.
.
-
deleteExport(params = {}, callback) ⇒ AWS.Request
Removes a previous export and the associated files stored in an S3 bucket.
.
-
deleteImport(params = {}, callback) ⇒ AWS.Request
Removes a previous import and the associated file stored in an S3 bucket.
.
-
deleteIntent(params = {}, callback) ⇒ AWS.Request
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
. -
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Removes an existing policy from a bot or bot alias.
-
deleteResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request
Deletes a policy statement from a resource policy.
-
deleteSlot(params = {}, callback) ⇒ AWS.Request
Deletes the specified slot from an intent.
.
-
deleteSlotType(params = {}, callback) ⇒ AWS.Request
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a
ResourceInUseException
exception. -
deleteTestSet(params = {}, callback) ⇒ AWS.Request
The action to delete the selected test set.
.
-
deleteUtterances(params = {}, callback) ⇒ AWS.Request
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot.
-
describeBot(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a bot.
-
describeBotAlias(params = {}, callback) ⇒ AWS.Request
Get information about a specific bot alias.
.
-
describeBotLocale(params = {}, callback) ⇒ AWS.Request
Describes the settings that a bot has for a specific locale.
-
describeBotRecommendation(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a bot recommendation.
-
describeBotReplica(params = {}, callback) ⇒ AWS.Request
Monitors the bot replication status through the UI console.
.
-
describeBotResourceGeneration(params = {}, callback) ⇒ AWS.Request
Returns information about a request to generate a bot through natural language description, made through the
StartBotResource
API. -
describeBotVersion(params = {}, callback) ⇒ AWS.Request
Provides metadata about a version of a bot.
.
-
describeCustomVocabularyMetadata(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a custom vocabulary.
.
-
describeExport(params = {}, callback) ⇒ AWS.Request
Gets information about a specific export.
.
-
describeImport(params = {}, callback) ⇒ AWS.Request
Gets information about a specific import.
.
-
describeIntent(params = {}, callback) ⇒ AWS.Request
Returns metadata about an intent.
.
-
describeResourcePolicy(params = {}, callback) ⇒ AWS.Request
Gets the resource policy and policy revision for a bot or bot alias.
.
-
describeSlot(params = {}, callback) ⇒ AWS.Request
Gets metadata information about a slot.
.
-
describeSlotType(params = {}, callback) ⇒ AWS.Request
Gets metadata information about a slot type.
.
-
describeTestExecution(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test execution.
.
-
describeTestSet(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set.
.
-
describeTestSetDiscrepancyReport(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set discrepancy report.
.
-
describeTestSetGeneration(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set generation.
.
-
generateBotElement(params = {}, callback) ⇒ AWS.Request
Generates sample utterances for an intent.
.
-
getTestExecutionArtifactsUrl(params = {}, callback) ⇒ AWS.Request
The pre-signed Amazon S3 URL to download the test execution result artifacts.
.
-
listAggregatedUtterances(params = {}, callback) ⇒ AWS.Request
Provides a list of utterances that users have sent to the bot.
Utterances are aggregated by the text of the utterance.
-
listBotAliases(params = {}, callback) ⇒ AWS.Request
Gets a list of aliases for the specified bot.
.
-
listBotAliasReplicas(params = {}, callback) ⇒ AWS.Request
The action to list the replicated bots created from the source bot alias.
.
-
listBotLocales(params = {}, callback) ⇒ AWS.Request
Gets a list of locales for the specified bot.
.
-
listBotRecommendations(params = {}, callback) ⇒ AWS.Request
Get a list of bot recommendations that meet the specified criteria.
.
-
listBotReplicas(params = {}, callback) ⇒ AWS.Request
The action to list the replicated bots.
.
-
listBotResourceGenerations(params = {}, callback) ⇒ AWS.Request
Lists the generation requests made for a bot locale.
.
-
listBots(params = {}, callback) ⇒ AWS.Request
Gets a list of available bots.
.
-
listBotVersionReplicas(params = {}, callback) ⇒ AWS.Request
Contains information about all the versions replication statuses applicable for Global Resiliency.
.
-
listBotVersions(params = {}, callback) ⇒ AWS.Request
Gets information about all of the versions of a bot.
The
ListBotVersions
operation returns a summary of each version of a bot. -
listBuiltInIntents(params = {}, callback) ⇒ AWS.Request
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
-
listBuiltInSlotTypes(params = {}, callback) ⇒ AWS.Request
Gets a list of built-in slot types that meet the specified criteria.
.
-
listCustomVocabularyItems(params = {}, callback) ⇒ AWS.Request
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
.
-
listExports(params = {}, callback) ⇒ AWS.Request
Lists the exports for a bot, bot locale, or custom vocabulary.
-
listImports(params = {}, callback) ⇒ AWS.Request
Lists the imports for a bot, bot locale, or custom vocabulary.
-
listIntentMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the intents in your bot.
-
listIntentPaths(params = {}, callback) ⇒ AWS.Request
Retrieves summary statistics for a path of intents that users take over sessions with your bot.
-
listIntents(params = {}, callback) ⇒ AWS.Request
Get a list of intents that meet the specified criteria.
.
-
listIntentStageMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the stages within intents in your bot.
-
listRecommendedIntents(params = {}, callback) ⇒ AWS.Request
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
-
listSessionAnalyticsData(params = {}, callback) ⇒ AWS.Request
Retrieves a list of metadata for individual user sessions with your bot.
-
listSessionMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the user sessions with your bot.
-
listSlots(params = {}, callback) ⇒ AWS.Request
Gets a list of slots that match the specified criteria.
.
-
listSlotTypes(params = {}, callback) ⇒ AWS.Request
Gets a list of slot types that match the specified criteria.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Gets a list of tags associated with a resource.
-
listTestExecutionResultItems(params = {}, callback) ⇒ AWS.Request
Gets a list of test execution result items.
.
-
listTestExecutions(params = {}, callback) ⇒ AWS.Request
The list of test set executions.
.
-
listTestSetRecords(params = {}, callback) ⇒ AWS.Request
The list of test set records.
.
-
listTestSets(params = {}, callback) ⇒ AWS.Request
The list of the test sets
.
-
listUtteranceAnalyticsData(params = {}, callback) ⇒ AWS.Request
Note: To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.
- listUtteranceMetrics(params = {}, callback) ⇒ AWS.Request
Note: To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.- searchAssociatedTranscripts(params = {}, callback) ⇒ AWS.Request
Search for associated transcripts that meet the specified criteria.
.
- startBotRecommendation(params = {}, callback) ⇒ AWS.Request
Use this to provide your transcript data, and to start the bot recommendation process.
.
- startBotResourceGeneration(params = {}, callback) ⇒ AWS.Request
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it.
- startImport(params = {}, callback) ⇒ AWS.Request
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
.
- startTestExecution(params = {}, callback) ⇒ AWS.Request
The action to start test set execution.
.
- startTestSetGeneration(params = {}, callback) ⇒ AWS.Request
The action to start the generation of test set.
.
- stopBotRecommendation(params = {}, callback) ⇒ AWS.Request
Stop an already running Bot Recommendation request.
.
- tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource.
- untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a bot, bot alias, or bot channel.
.
- updateBot(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing bot.
- updateBotAlias(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing bot alias.
.
- updateBotLocale(params = {}, callback) ⇒ AWS.Request
Updates the settings that a bot has for a specific locale.
.
- updateBotRecommendation(params = {}, callback) ⇒ AWS.Request
Updates an existing bot recommendation request.
.
- updateExport(params = {}, callback) ⇒ AWS.Request
Updates the password used to protect an export zip archive.
The password is not required.
- updateIntent(params = {}, callback) ⇒ AWS.Request
Updates the settings for an intent.
.
- updateResourcePolicy(params = {}, callback) ⇒ AWS.Request
Replaces the existing resource policy for a bot or bot alias with a new one.
- updateSlot(params = {}, callback) ⇒ AWS.Request
Updates the settings for a slot.
.
- updateSlotType(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing slot type.
.
- updateTestSet(params = {}, callback) ⇒ AWS.Request
The action to update the test set.
.
- waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given LexModelsV2 resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
new AWS.LexModelsV2(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a LexModelsV2 object
var lexmodelsv2 = new AWS.LexModelsV2({apiVersion: '2020-08-07'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.LexModelsV2.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.LexModelsV2.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.LexModelsV2.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
batchCreateCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Service Reference:
Examples:
Calling the batchCreateCustomVocabularyItem operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ customVocabularyItemList: [ /* required */ { phrase: 'STRING_VALUE', /* required */ displayAs: 'STRING_VALUE', weight: 'NUMBER_VALUE' }, /* more items */ ], localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.batchCreateCustomVocabularyItem(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
customVocabularyItemList
— (Array<map>
)A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
phrase
— required — (String
)The unique phrase for the new custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned to the new custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The display as value assigned to the new custom vocabulary item from the custom vocabulary list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
errors
— (Array<map>
)A list of custom vocabulary items that failed to create during the operation. The reason for the error is contained within each error object.
itemId
— (String
)The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
errorMessage
— (String
)The error message for the failed custom vocabulary item from the custom vocabulary list.
errorCode
— (String
)The unique error code for the failed custom vocabulary item from the custom vocabulary list.
Possible values include:"DUPLICATE_INPUT"
"RESOURCE_DOES_NOT_EXIST"
"RESOURCE_ALREADY_EXISTS"
"INTERNAL_SERVER_FAILURE"
resources
— (Array<map>
)A list of custom vocabulary items that were successfully created during the operation.
itemId
— required — (String
)The unique item identifer for the custom vocabulary item from the custom vocabulary list.
phrase
— required — (String
)The unique phrase for the custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned for the custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
-
(AWS.Response)
—
Returns:
batchDeleteCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Service Reference:
Examples:
Calling the batchDeleteCustomVocabularyItem operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ customVocabularyItemList: [ /* required */ { itemId: 'STRING_VALUE' /* required */ }, /* more items */ ], localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.batchDeleteCustomVocabularyItem(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
customVocabularyItemList
— (Array<map>
)A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.
itemId
— required — (String
)The unique item identifier for the custom vocabulary items.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
errors
— (Array<map>
)A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.
itemId
— (String
)The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
errorMessage
— (String
)The error message for the failed custom vocabulary item from the custom vocabulary list.
errorCode
— (String
)The unique error code for the failed custom vocabulary item from the custom vocabulary list.
Possible values include:"DUPLICATE_INPUT"
"RESOURCE_DOES_NOT_EXIST"
"RESOURCE_ALREADY_EXISTS"
"INTERNAL_SERVER_FAILURE"
resources
— (Array<map>
)A list of custom vocabulary items that were successfully deleted during the operation.
itemId
— required — (String
)The unique item identifer for the custom vocabulary item from the custom vocabulary list.
phrase
— required — (String
)The unique phrase for the custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned for the custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
-
(AWS.Response)
—
Returns:
batchUpdateCustomVocabularyItem(params = {}, callback) ⇒ AWS.Request
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Service Reference:
Examples:
Calling the batchUpdateCustomVocabularyItem operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ customVocabularyItemList: [ /* required */ { itemId: 'STRING_VALUE', /* required */ phrase: 'STRING_VALUE', /* required */ displayAs: 'STRING_VALUE', weight: 'NUMBER_VALUE' }, /* more items */ ], localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.batchUpdateCustomVocabularyItem(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot associated with this custom vocabulary
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
customVocabularyItemList
— (Array<map>
)A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
itemId
— required — (String
)The unique item identifer for the custom vocabulary item from the custom vocabulary list.
phrase
— required — (String
)The unique phrase for the custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned for the custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
errors
— (Array<map>
)A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.
itemId
— (String
)The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
errorMessage
— (String
)The error message for the failed custom vocabulary item from the custom vocabulary list.
errorCode
— (String
)The unique error code for the failed custom vocabulary item from the custom vocabulary list.
Possible values include:"DUPLICATE_INPUT"
"RESOURCE_DOES_NOT_EXIST"
"RESOURCE_ALREADY_EXISTS"
"INTERNAL_SERVER_FAILURE"
resources
— (Array<map>
)A list of custom vocabulary items that were successfully updated during the operation.
itemId
— required — (String
)The unique item identifer for the custom vocabulary item from the custom vocabulary list.
phrase
— required — (String
)The unique phrase for the custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned for the custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
-
(AWS.Response)
—
Returns:
buildBotLocale(params = {}, callback) ⇒ AWS.Request
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
Service Reference:
Examples:
Calling the buildBotLocale operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.buildBotLocale(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.
botVersion
— (String
)The version of the bot to build. This can only be the draft version of the bot.
localeId
— (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the specified bot.
botVersion
— (String
)The version of the bot that was built. This is only the draft version of the bot.
localeId
— (String
)The language and locale specified of where the bot can be used.
botLocaleStatus
— (String
)The bot's build status. When the status is
Possible values include:ReadyExpressTesting
you can test the bot using the utterances defined for the intents and slot types. When the status isBuilt
, the bot is ready for use and can be tested using any utterance."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
lastBuildSubmittedDateTime
— (Date
)A timestamp indicating the date and time that the bot was last built for this locale.
-
(AWS.Response)
—
Returns:
createBot(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Lex conversational bot.
Service Reference:
Examples:
Calling the createBot operation
var params = { botName: 'STRING_VALUE', /* required */ dataPrivacy: { /* required */ childDirected: true || false /* required */ }, idleSessionTTLInSeconds: 'NUMBER_VALUE', /* required */ roleArn: 'STRING_VALUE', /* required */ botMembers: [ { botMemberAliasId: 'STRING_VALUE', /* required */ botMemberAliasName: 'STRING_VALUE', /* required */ botMemberId: 'STRING_VALUE', /* required */ botMemberName: 'STRING_VALUE', /* required */ botMemberVersion: 'STRING_VALUE' /* required */ }, /* more items */ ], botTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, botType: Bot | BotNetwork, description: 'STRING_VALUE', testBotAliasTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; lexmodelsv2.createBot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botName
— (String
)The name of the bot. The bot name must be unique in the account that creates the bot.
description
— (String
)A description of the bot. It appears in lists to help you identify a particular bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
dataPrivacy
— (map
)Provides information on additional privacy protections Amazon Lex should use with the bot's data.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags
— (map<String>
)A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation.testBotAliasTags
— (map<String>
)A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.botType
— (String
)The type of a bot to create.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bot members in a network to be created.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
botName
— (String
)The name specified for the bot.
description
— (String
)The description specified for the bot.
roleArn
— (String
)The IAM role specified for the bot.
dataPrivacy
— (map
)The data privacy settings specified for the bot.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The session idle time specified for the bot.
botStatus
— (String
)Shows the current status of the bot. The bot is first in the
Possible values include:Creating
status. Once the bot is read for use, it changes to theAvailable
status. After the bot is created, you can use theDRAFT
version of the bot."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp indicating the date and time that the bot was created.
botTags
— (map<String>
)A list of tags associated with the bot.
testBotAliasTags
— (map<String>
)A list of tags associated with the test alias for the bot.
botType
— (String
)The type of a bot that was created.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bots in a network that was created.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
-
(AWS.Response)
—
Returns:
createBotAlias(params = {}, callback) ⇒ AWS.Request
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
Service Reference:
Examples:
Calling the createBotAlias operation
var params = { botAliasName: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ botAliasLocaleSettings: { '<LocaleId>': { enabled: true || false, /* required */ codeHookSpecification: { lambdaCodeHook: { /* required */ codeHookInterfaceVersion: 'STRING_VALUE', /* required */ lambdaARN: 'STRING_VALUE' /* required */ } } }, /* '<LocaleId>': ... */ }, botVersion: 'STRING_VALUE', conversationLogSettings: { audioLogSettings: [ { destination: { /* required */ s3Bucket: { /* required */ logPrefix: 'STRING_VALUE', /* required */ s3BucketArn: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' } }, enabled: true || false, /* required */ selectiveLoggingEnabled: true || false }, /* more items */ ], textLogSettings: [ { destination: { /* required */ cloudWatch: { /* required */ cloudWatchLogGroupArn: 'STRING_VALUE', /* required */ logPrefix: 'STRING_VALUE' /* required */ } }, enabled: true || false, /* required */ selectiveLoggingEnabled: true || false }, /* more items */ ] }, description: 'STRING_VALUE', sentimentAnalysisSettings: { detectSentiment: true || false /* required */ }, tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; lexmodelsv2.createBotAlias(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botAliasName
— (String
)The alias to create. The name must be unique for the bot.
description
— (String
)A description of the alias. Use this description to help identify the alias.
botVersion
— (String
)The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
botAliasLocaleSettings
— (map<map>
)Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botId
— (String
)The unique identifier of the bot that the alias applies to.
tags
— (map<String>
)A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the
UpdateBotAlias
operation to update the tags on a bot alias. To update tags, use theTagResource
operation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasId
— (String
)The unique identifier of the bot alias.
botAliasName
— (String
)The name specified for the bot alias.
description
— (String
)The description specified for the bot alias.
botVersion
— (String
)The version of the bot associated with this alias.
botAliasLocaleSettings
— (map<map>
)Configuration information for a specific locale.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)The conversation log settings specified for the alias.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botAliasStatus
— (String
)The current status of the alias. The alias is first put into the
Possible values include:Creating
state. When the alias is ready to be used, it is put into theAvailable
state. You can use theDescribeBotAlias
operation to get the current state of an alias."Creating"
"Available"
"Deleting"
"Failed"
botId
— (String
)The unique identifier of the bot that this alias applies to.
creationDateTime
— (Date
)A Unix timestamp indicating the date and time that the bot alias was created.
tags
— (map<String>
)A list of tags associated with the bot alias.
-
(AWS.Response)
—
Returns:
createBotLocale(params = {}, callback) ⇒ AWS.Request
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
Service Reference:
Examples:
Calling the createBotLocale operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ nluIntentConfidenceThreshold: 'NUMBER_VALUE', /* required */ description: 'STRING_VALUE', generativeAISettings: { buildtimeSettings: { descriptiveBotBuilder: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } }, sampleUtteranceGeneration: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } } }, runtimeSettings: { slotResolutionImprovement: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } } } }, voiceSettings: { voiceId: 'STRING_VALUE', /* required */ engine: standard | neural } }; lexmodelsv2.createBotLocale(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to create the locale for.
botVersion
— (String
)The version of the bot to create the locale for. This can only be the draft version of the bot.
localeId
— (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
description
— (String
)A description of the bot locale. Use this to help identify the bot locale in lists.
nluIntentConfidenceThreshold
— (Float
)Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from theRecognizeText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voiceSettings
— (map
)The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
generativeAISettings
— (map
)Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The specified bot identifier.
botVersion
— (String
)The specified bot version.
localeName
— (String
)The specified locale name.
localeId
— (String
)The specified locale identifier.
description
— (String
)The specified description of the bot locale.
nluIntentConfidenceThreshold
— (Float
)The specified confidence threshold for inserting the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents.voiceSettings
— (map
)The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
botLocaleStatus
— (String
)The status of the bot.
When the status is
Creating
the bot locale is being configured. When the status isBuilding
Amazon Lex is building the bot for testing and use.If the status of the bot is
ReadyExpressTesting
, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status isBuilt
.If there was a problem with building the bot, the status is
Possible values include:Failed
. If the bot was saved but not built, the status isNotBuilt
."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
creationDateTime
— (Date
)A timestamp specifying the date and time that the bot locale was created.
generativeAISettings
— (map
)Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
createBotReplica(params = {}, callback) ⇒ AWS.Request
Action to create a replication of the source bot in the secondary region.
Service Reference:
Examples:
Calling the createBotReplica operation
var params = { botId: 'STRING_VALUE', /* required */ replicaRegion: 'STRING_VALUE' /* required */ }; lexmodelsv2.createBotReplica(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The request for the unique bot ID of the source bot to be replicated in the secondary region.
replicaRegion
— (String
)The request for the secondary region that will be used in the replication of the source bot.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique bot ID of the replicated bot generated.
replicaRegion
— (String
)The region of the replicated bot generated.
sourceRegion
— (String
)The source region for the source bot used for the replicated bot generated.
creationDateTime
— (Date
)The creation date and time of the replicated bot generated.
botReplicaStatus
— (String
)The operational status of the replicated bot generated.
Possible values include:"Enabling"
"Enabled"
"Deleting"
"Failed"
-
(AWS.Response)
—
Returns:
createBotVersion(params = {}, callback) ⇒ AWS.Request
Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.
Service Reference:
Examples:
Calling the createBotVersion operation
var params = { botId: 'STRING_VALUE', /* required */ botVersionLocaleSpecification: { /* required */ '<LocaleId>': { sourceBotVersion: 'STRING_VALUE' /* required */ }, /* '<LocaleId>': ... */ }, description: 'STRING_VALUE' }; lexmodelsv2.createBotVersion(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to create the version for.
description
— (String
)A description of the version. Use the description to help identify the version in lists.
botVersionLocaleSpecification
— (map<map>
)Specifies the locales that Amazon Lex adds to this version. You can choose the
Draft
version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.sourceBotVersion
— required — (String
)The version of a bot used for a bot locale.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The bot identifier specified in the request.
description
— (String
)The description of the version specified in the request.
botVersion
— (String
)The version number assigned to the version.
botVersionLocaleSpecification
— (map<map>
)The source versions used for each locale in the new version.
sourceBotVersion
— required — (String
)The version of a bot used for a bot locale.
botStatus
— (String
)When you send a request to create or update a bot, Amazon Lex sets the status response element to
Possible values include:Creating
. After Amazon Lex builds the bot, it sets status toAvailable
. If Amazon Lex can't build the bot, it sets status toFailed
."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp of the date and time that the version was created.
-
(AWS.Response)
—
Returns:
createExport(params = {}, callback) ⇒ AWS.Request
Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.
You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.
For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots
Service Reference:
Examples:
Calling the createExport operation
var params = { fileFormat: LexJson | TSV | CSV, /* required */ resourceSpecification: { /* required */ botExportSpecification: { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE' /* required */ }, botLocaleExportSpecification: { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }, customVocabularyExportSpecification: { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }, testSetExportSpecification: { testSetId: 'STRING_VALUE' /* required */ } }, filePassword: 'STRING_VALUE' }; lexmodelsv2.createExport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceSpecification
— (map
)Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format of the bot or bot locale definition files.
Possible values include:"LexJson"
"TSV"
"CSV"
filePassword
— (String
)An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:exportId
— (String
)An identifier for a specific request to create an export.
resourceSpecification
— (map
)A description of the type of resource that was exported, either a bot or a bot locale.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format used for the bot or bot locale definition files.
Possible values include:"LexJson"
"TSV"
"CSV"
exportStatus
— (String
)The status of the export. When the status is
Possible values include:Completed
, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale."InProgress"
"Completed"
"Failed"
"Deleting"
creationDateTime
— (Date
)The date and time that the request to export a bot was created.
-
(AWS.Response)
—
Returns:
createIntent(params = {}, callback) ⇒ AWS.Request
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an
OrderPizza
intent.When you create an intent, you must provide a name. You can optionally provide the following:
-
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
-
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
-
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
-
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
-
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
Service Reference:
Examples:
Calling the createIntent operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentName: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ description: 'STRING_VALUE', dialogCodeHook: { enabled: true || false /* required */ }, fulfillmentCodeHook: { enabled: true || false, /* required */ active: true || false, fulfillmentUpdatesSpecification: { active: true || false, /* required */ startResponse: { delayInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutInSeconds: 'NUMBER_VALUE', updateResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, postFulfillmentStatusSpecification: { failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, initialResponseSetting: { codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, conditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, initialResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } } }, inputContexts: [ { name: 'STRING_VALUE' /* required */ }, /* more items */ ], intentClosingSetting: { active: true || false, closingResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, conditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } } }, intentConfirmationSetting: { promptSpecification: { /* required */ maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, active: true || false, codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, confirmationConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, confirmationNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, confirmationResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, declinationConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, declinationNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, declinationResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, elicitationCodeHook: { enableCodeHookInvocation: true || false, /* required */ invocationLabel: 'STRING_VALUE' }, failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, kendraConfiguration: { kendraIndex: 'STRING_VALUE', /* required */ queryFilterString: 'STRING_VALUE', queryFilterStringEnabled: true || false }, outputContexts: [ { name: 'STRING_VALUE', /* required */ timeToLiveInSeconds: 'NUMBER_VALUE', /* required */ turnsToLive: 'NUMBER_VALUE' /* required */ }, /* more items */ ], parentIntentSignature: 'STRING_VALUE', qnAIntentConfiguration: { bedrockModelConfiguration: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED }, dataSourceConfiguration: { bedrockKnowledgeStoreConfiguration: { bedrockKnowledgeBaseArn: 'STRING_VALUE', /* required */ exactResponse: true || false, exactResponseFields: { answerField: 'STRING_VALUE' } }, kendraConfiguration: { kendraIndex: 'STRING_VALUE', /* required */ exactResponse: true || false, queryFilterString: 'STRING_VALUE', queryFilterStringEnabled: true || false }, opensearchConfiguration: { domainEndpoint: 'STRING_VALUE', /* required */ indexName: 'STRING_VALUE', /* required */ exactResponse: true || false, exactResponseFields: { answerField: 'STRING_VALUE', /* required */ questionField: 'STRING_VALUE' /* required */ }, includeFields: [ 'STRING_VALUE', /* more items */ ] } } }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ] }; lexmodelsv2.createIntent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
intentName
— (String
)The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
description
— (String
)A description of the intent. Use the description to help identify the intent in lists.
parentIntentSignature
— (String
)A unique identifier for the built-in intent to base this intent on.
sampleUtterances
— (Array<map>
)An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a
{PizzaSize}
pizza".In an utterance, slot names are enclosed in curly braces (""") to indicate where they should be displayed in the utterance shown to the user..
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook
— (map
)Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot,
glutenIntolerant
totrue
. You might find John's phone number and set the corresponding session attribute.enabled
— required — (Boolean
)Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook
— (map
)Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
enabled
— required — (Boolean
)Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification
— (map
)Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the fulfillment code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the fulfillment code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
fulfillmentUpdatesSpecification
— (map
)Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active
— required — (Boolean
)Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required.startResponse
— (map
)Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds
— required — (Integer
)The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt the start message while it is playing.
updateResponse
— (map
)Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds
— required — (Integer
)The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds
— (Integer
)The length of time that the fulfillment Lambda function should run before it times out.
active
— (Boolean
)Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run.
intentConfirmationSetting
— (map
)Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
promptSpecification
— required — (map
)Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
declinationResponse
— (map
)When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true.confirmationResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
confirmationNextStep
— (map
)Specifies the next step that the bot executes when the customer confirms the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
confirmationConditional
— (map
)A list of conditional branches to evaluate after the intent is closed.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
declinationNextStep
— (map
)Specifies the next step that the bot executes when the customer declines the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
declinationConditional
— (map
)A list of conditional branches to evaluate after the intent is declined.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)The next step to take in the conversation if the confirmation step fails.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
intentClosingSetting
— (map
)Sets the response that Amazon Lex sends to the user when the intent is closed.
closingResponse
— (map
)The response that Amazon Lex sends to the user when the intent is complete.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true.nextStep
— (map
)Specifies the next step that the bot executes after playing the intent's closing response.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
inputContexts
— (Array<map>
)A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the
outputContexts
property or it can be set at runtime.For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the
outputContextsList
property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration
— (map
)Configuration information required to use the
AMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index. TheAMAZON.KendraSearchIntent
intent is called when Amazon Lex can't determine another intent to invoke.kendraIndex
— required — (String
)The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot.queryFilterStringEnabled
— (Boolean
)Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.queryFilterString
— (String
)A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
botId
— (String
)The identifier of the bot associated with this intent.
botVersion
— (String
)The version of the bot associated with this intent.
localeId
— (String
)The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.
initialResponseSetting
— (map
)Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
initialResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
qnAIntentConfiguration
— (map
)Specifies the configuration of the built-in
Amazon.QnAIntent
. TheAMAZON.QnAIntent
intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify thekendraConfiguration
field.dataSourceConfiguration
— (map
)Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.opensearchConfiguration
— (map
)Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.domainEndpoint
— required — (String
)The endpoint of the Amazon OpenSearch Service domain.
indexName
— required — (String
)The name of the Amazon OpenSearch Service index.
exactResponse
— (Boolean
)Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
questionField
— required — (String
)The name of the field that contains the query made to the OpenSearch Service database.
answerField
— required — (String
)The name of the field that contains the answer to the query made to the OpenSearch Service database.
includeFields
— (Array<String>
)Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
kendraConfiguration
— (map
)Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index.kendraIndex
— required — (String
)The ARN of the Amazon Kendra index to use.
queryFilterStringEnabled
— (Boolean
)Specifies whether to enable an Amazon Kendra filter string or not.
queryFilterString
— (String
)Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
exactResponse
— (Boolean
)Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
bedrockKnowledgeStoreConfiguration
— (map
)Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base.bedrockKnowledgeBaseArn
— required — (String
)The base ARN of the knowledge base used.
exactResponse
— (Boolean
)Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
answerField
— (String
)The answer field used for an exact response from Bedrock Knowledge Store.
bedrockModelConfiguration
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:intentId
— (String
)A unique identifier for the intent.
intentName
— (String
)The name specified for the intent.
description
— (String
)The description specified for the intent.
parentIntentSignature
— (String
)The signature of the parent intent specified for the intent.
sampleUtterances
— (Array<map>
)The sample utterances specified for the intent.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook
— (map
)The dialog Lambda function specified for the intent.
enabled
— required — (Boolean
)Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook
— (map
)The fulfillment Lambda function specified for the intent.
enabled
— required — (Boolean
)Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification
— (map
)Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the fulfillment code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the fulfillment code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
fulfillmentUpdatesSpecification
— (map
)Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active
— required — (Boolean
)Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required.startResponse
— (map
)Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds
— required — (Integer
)The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt the start message while it is playing.
updateResponse
— (map
)Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds
— required — (Integer
)The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds
— (Integer
)The length of time that the fulfillment Lambda function should run before it times out.
active
— (Boolean
)Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run.
intentConfirmationSetting
— (map
)The confirmation setting specified for the intent.
promptSpecification
— required — (map
)Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
declinationResponse
— (map
)When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true.confirmationResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
confirmationNextStep
— (map
)Specifies the next step that the bot executes when the customer confirms the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
confirmationConditional
— (map
)A list of conditional branches to evaluate after the intent is closed.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
declinationNextStep
— (map
)Specifies the next step that the bot executes when the customer declines the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
declinationConditional
— (map
)A list of conditional branches to evaluate after the intent is declined.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)The next step to take in the conversation if the confirmation step fails.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
intentClosingSetting
— (map
)The closing setting specified for the intent.
closingResponse
— (map
)The response that Amazon Lex sends to the user when the intent is complete.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true.nextStep
— (map
)Specifies the next step that the bot executes after playing the intent's closing response.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
inputContexts
— (Array<map>
)The list of input contexts specified for the intent.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)The list of output contexts specified for the intent.
name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration
— (map
)Configuration for searching a Amazon Kendra index specified for the intent.
kendraIndex
— required — (String
)The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot.queryFilterStringEnabled
— (Boolean
)Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.queryFilterString
— (String
)A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
botId
— (String
)The identifier of the bot associated with the intent.
botVersion
— (String
)The version of the bot associated with the intent.
localeId
— (String
)The locale that the intent is specified to use.
creationDateTime
— (Date
)A timestamp of the date and time that the intent was created.
initialResponseSetting
— (map
)Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
initialResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
qnAIntentConfiguration
— (map
)Details about the the configuration of the built-in
Amazon.QnAIntent
.dataSourceConfiguration
— (map
)Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.opensearchConfiguration
— (map
)Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.domainEndpoint
— required — (String
)The endpoint of the Amazon OpenSearch Service domain.
indexName
— required — (String
)The name of the Amazon OpenSearch Service index.
exactResponse
— (Boolean
)Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
questionField
— required — (String
)The name of the field that contains the query made to the OpenSearch Service database.
answerField
— required — (String
)The name of the field that contains the answer to the query made to the OpenSearch Service database.
includeFields
— (Array<String>
)Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
kendraConfiguration
— (map
)Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index.kendraIndex
— required — (String
)The ARN of the Amazon Kendra index to use.
queryFilterStringEnabled
— (Boolean
)Specifies whether to enable an Amazon Kendra filter string or not.
queryFilterString
— (String
)Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
exactResponse
— (Boolean
)Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
bedrockKnowledgeStoreConfiguration
— (map
)Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base.bedrockKnowledgeBaseArn
— required — (String
)The base ARN of the knowledge base used.
exactResponse
— (Boolean
)Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
answerField
— (String
)The answer field used for an exact response from Bedrock Knowledge Store.
bedrockModelConfiguration
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
createResourcePolicy(params = {}, callback) ⇒ AWS.Request
Creates a new resource policy with the specified policy statements.
Service Reference:
Examples:
Calling the createResourcePolicy operation
var params = { policy: 'STRING_VALUE', /* required */ resourceArn: 'STRING_VALUE' /* required */ }; lexmodelsv2.createResourcePolicy(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy
— (String
)A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
If the policy isn't valid, Amazon Lex returns a validation exception.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
createResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.
You can't create a resource policy statement that allows cross-account access.
You need to add the
CreateResourcePolicy
orUpdateResourcePolicy
action to the bot role in order to call the API.Service Reference:
Examples:
Calling the createResourcePolicyStatement operation
var params = { action: [ /* required */ 'STRING_VALUE', /* more items */ ], effect: Allow | Deny, /* required */ principal: [ /* required */ { arn: 'STRING_VALUE', service: 'STRING_VALUE' }, /* more items */ ], resourceArn: 'STRING_VALUE', /* required */ statementId: 'STRING_VALUE', /* required */ condition: { '<ConditionOperator>': { '<ConditionKey>': 'STRING_VALUE', /* '<ConditionKey>': ... */ }, /* '<ConditionOperator>': ... */ }, expectedRevisionId: 'STRING_VALUE' }; lexmodelsv2.createResourcePolicyStatement(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
statementId
— (String
)The name of the statement. The ID is the same as the
Sid
IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.effect
— (String
)Determines whether the statement allows or denies access to the resource.
Possible values include:"Allow"
"Deny"
principal
— (Array<map>
)An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.
service
— (String
)The name of the Amazon Web Services service that should allowed or denied access to an Amazon Lex action.
arn
— (String
)The Amazon Resource Name (ARN) of the principal.
action
— (Array<String>
)The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.
condition
— (map<map<String>>
)Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.
For more information, see IAM JSON policy elements: Condition .
expectedRevisionId
— (String
)The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
createSlot(params = {}, callback) ⇒ AWS.Request
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.Service Reference:
Examples:
Calling the createSlot operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotName: 'STRING_VALUE', /* required */ valueElicitationSetting: { /* required */ slotConstraint: Required | Optional, /* required */ defaultValueSpecification: { defaultValueList: [ /* required */ { defaultValue: 'STRING_VALUE' /* required */ }, /* more items */ ] }, promptSpecification: { maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ], slotCaptureSetting: { captureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, captureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, captureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, elicitationCodeHook: { enableCodeHookInvocation: true || false, /* required */ invocationLabel: 'STRING_VALUE' }, failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, slotResolutionSetting: { slotResolutionStrategy: EnhancedFallback | Default /* required */ }, waitAndContinueSpecification: { continueResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, waitingResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, active: true || false, stillWaitingResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], timeoutInSeconds: 'NUMBER_VALUE', /* required */ allowInterrupt: true || false } } }, description: 'STRING_VALUE', multipleValuesSetting: { allowMultipleValues: true || false }, obfuscationSetting: { obfuscationSettingType: None | DefaultObfuscation /* required */ }, slotTypeId: 'STRING_VALUE', subSlotSetting: { expression: 'STRING_VALUE', slotSpecifications: { '<Name>': { slotTypeId: 'STRING_VALUE', /* required */ valueElicitationSetting: { /* required */ promptSpecification: { /* required */ maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, defaultValueSpecification: { defaultValueList: [ /* required */ { defaultValue: 'STRING_VALUE' /* required */ }, /* more items */ ] }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ], waitAndContinueSpecification: { continueResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, waitingResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, active: true || false, stillWaitingResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], timeoutInSeconds: 'NUMBER_VALUE', /* required */ allowInterrupt: true || false } } } }, /* '<Name>': ... */ } } }; lexmodelsv2.createSlot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotName
— (String
)The name of the slot. Slot names must be unique within the bot that contains the slot.
description
— (String
)A description of the slot. Use this to help identify the slot in lists.
slotTypeId
— (String
)The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
valueElicitationSetting
— (map
)Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
defaultValueSpecification
— (map
)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, session attributes, and defined values.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
slotConstraint
— required — (String
)Specifies whether the slot is required or optional.
Possible values include:"Required"
"Optional"
promptSpecification
— (map
)The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)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.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
slotCaptureSetting
— (map
)Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
captureNextStep
— (map
)Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
captureConditional
— (map
)A list of conditional branches to evaluate after the slot value is captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate when the slot value isn't captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)Code hook called when Amazon Lex doesn't capture a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
slotResolutionSetting
— (map
)An object containing information about whether assisted slot resolution is turned on for the slot or not.
slotResolutionStrategy
— required — (String
)Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
Possible values include:EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off."EnhancedFallback"
"Default"
obfuscationSetting
— (map
)Determines how slot values are used in Amazon CloudWatch logs. If the value of the
obfuscationSetting
parameter isDefaultObfuscation
, slot values are obfuscated in the log output. If the value isNone
, the actual value is present in the log output.The default is to obfuscate values in the CloudWatch logs.
obfuscationSettingType
— required — (String
)Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Possible values include:"None"
"DefaultObfuscation"
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 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.
intentId
— (String
)The identifier of the intent that contains the slot.
multipleValuesSetting
— (map
)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 totrue
in any other locale, Amazon Lex throws aValidationException
.If the
multipleValuesSetting
is not set, the default value isfalse
.allowMultipleValues
— (Boolean
)Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, 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 aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
subSlotSetting
— (map
)Specifications for the constituent sub slots and the expression for the composite slot.
expression
— (String
)The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
slotSpecifications
— (map<map>
)Specifications for the constituent sub slots of a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to the slot type.
valueElicitationSetting
— required — (map
)Specifies the elicitation setting details for constituent sub slots of a composite slot.
defaultValueSpecification
— (map
)Defines a list of values that Amazon Lex should use as the default value for a slot.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
promptSpecification
— required — (map
)Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots.utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (map
)The value elicitation settings specified for the slot.
defaultValueSpecification
— (map
)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, session attributes, and defined values.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
slotConstraint
— required — (String
)Specifies whether the slot is required or optional.
Possible values include:"Required"
"Optional"
promptSpecification
— (map
)The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)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.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
slotCaptureSetting
— (map
)Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
captureNextStep
— (map
)Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
captureConditional
— (map
)A list of conditional branches to evaluate after the slot value is captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate when the slot value isn't captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)Code hook called when Amazon Lex doesn't capture a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
slotResolutionSetting
— (map
)An object containing information about whether assisted slot resolution is turned on for the slot or not.
slotResolutionStrategy
— required — (String
)Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
Possible values include:EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off."EnhancedFallback"
"Default"
obfuscationSetting
— (map
)Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
obfuscationSettingType
— required — (String
)Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Possible values include:"None"
"DefaultObfuscation"
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
— (Date
)The timestamp of the date and time that the slot was created.
multipleValuesSetting
— (map
)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. Whenfalse
, 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 aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
subSlotSetting
— (map
)Specifications for the constituent sub slots and the expression for the composite slot.
expression
— (String
)The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
slotSpecifications
— (map<map>
)Specifications for the constituent sub slots of a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to the slot type.
valueElicitationSetting
— required — (map
)Specifies the elicitation setting details for constituent sub slots of a composite slot.
defaultValueSpecification
— (map
)Defines a list of values that Amazon Lex should use as the default value for a slot.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
promptSpecification
— required — (map
)Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots.utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
-
(AWS.Response)
—
Returns:
createSlotType(params = {}, callback) ⇒ AWS.Request
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
Service Reference:
Examples:
Calling the createSlotType operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotTypeName: 'STRING_VALUE', /* required */ compositeSlotTypeSetting: { subSlots: [ { name: 'STRING_VALUE', /* required */ slotTypeId: 'STRING_VALUE' /* required */ }, /* more items */ ] }, description: 'STRING_VALUE', externalSourceSetting: { grammarSlotTypeSetting: { source: { s3BucketName: 'STRING_VALUE', /* required */ s3ObjectKey: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' } } }, parentSlotTypeSignature: 'STRING_VALUE', slotTypeValues: [ { sampleValue: { value: 'STRING_VALUE' /* required */ }, synonyms: [ { value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, /* more items */ ], valueSelectionSetting: { resolutionStrategy: OriginalValue | TopResolution | Concatenation, /* required */ advancedRecognitionSetting: { audioRecognitionStrategy: UseSlotValuesAsCustomVocabulary }, regexFilter: { pattern: 'STRING_VALUE' /* required */ } } }; lexmodelsv2.createSlotType(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotTypeName
— (String
)The name for the slot. A slot type name must be unique within the intent.
description
— (String
)A description of the slot type. Use the description to help identify the slot type in lists.
slotTypeValues
— (Array<map>
)A list of
SlotTypeValue
objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.sampleValue
— (map
)The value of the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
synonyms
— (Array<map>
)Additional values related to the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
valueSelectionSetting
— (map
)Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.
If you don't specify the
valueSelectionSetting
parameter, the default isORIGINAL_VALUE
.resolutionStrategy
— required — (String
)Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
Possible values include:valueSelectionStrategy
, the default isORIGINAL_VALUE
."OriginalValue"
"TopResolution"
"Concatenation"
-
regexFilter
— (map
)A regular expression used to validate the value of a slot.
pattern
— required — (String
)A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or
{x,}
with no upper bound. -
Wild card (.)
-
advancedRecognitionSetting
— (map
)Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
audioRecognitionStrategy
— (String
)Enables using the slot values as a custom vocabulary for recognizing user utterances.
Possible values include:"UseSlotValuesAsCustomVocabulary"
-
parentSlotTypeSignature
— (String
)The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only
AMAZON.AlphaNumeric
is supported.botId
— (String
)The identifier of the bot associated with this slot type.
botVersion
— (String
)The identifier of the bot version associated with this slot type.
localeId
— (String
)The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
externalSourceSetting
— (map
)Sets the type of external information used to create the slot type.
grammarSlotTypeSetting
— (map
)Settings required for a slot type based on a grammar that you provide.
source
— (map
)The source of the grammar used to create the slot type.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket that contains the grammar source.
s3ObjectKey
— required — (String
)The path to the grammar in the Amazon S3 bucket.
kmsKeyArn
— (String
)The KMS key required to decrypt the contents of the grammar, if any.
compositeSlotTypeSetting
— (map
)Specifications for a composite slot type.
subSlots
— (Array<map>
)Subslots in the composite slot.
name
— required — (String
)Name of a constituent sub slot inside a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:slotTypeId
— (String
)The unique identifier assigned to the slot type. Use this to identify the slot type in the
UpdateSlotType
andDeleteSlotType
operations.slotTypeName
— (String
)The name specified for the slot type.
description
— (String
)The description specified for the slot type.
slotTypeValues
— (Array<map>
)The list of values that the slot type can assume.
sampleValue
— (map
)The value of the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
synonyms
— (Array<map>
)Additional values related to the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
valueSelectionSetting
— (map
)The strategy that Amazon Lex uses to select a value from the list of possible values.
resolutionStrategy
— required — (String
)Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
Possible values include:valueSelectionStrategy
, the default isORIGINAL_VALUE
."OriginalValue"
"TopResolution"
"Concatenation"
-
regexFilter
— (map
)A regular expression used to validate the value of a slot.
pattern
— required — (String
)A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or
{x,}
with no upper bound. -
Wild card (.)
-
advancedRecognitionSetting
— (map
)Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
audioRecognitionStrategy
— (String
)Enables using the slot values as a custom vocabulary for recognizing user utterances.
Possible values include:"UseSlotValuesAsCustomVocabulary"
parentSlotTypeSignature
— (String
)The signature of the base slot type specified for the slot type.
botId
— (String
)The identifier for the bot associated with the slot type.
botVersion
— (String
)The version of the bot associated with the slot type.
localeId
— (String
)The specified language and local specified for the slot type.
creationDateTime
— (Date
)A timestamp of the date and time that the slot type was created.
externalSourceSetting
— (map
)The type of external information used to create the slot type.
grammarSlotTypeSetting
— (map
)Settings required for a slot type based on a grammar that you provide.
source
— (map
)The source of the grammar used to create the slot type.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket that contains the grammar source.
s3ObjectKey
— required — (String
)The path to the grammar in the Amazon S3 bucket.
kmsKeyArn
— (String
)The KMS key required to decrypt the contents of the grammar, if any.
compositeSlotTypeSetting
— (map
)Specifications for a composite slot type.
subSlots
— (Array<map>
)Subslots in the composite slot.
name
— required — (String
)Name of a constituent sub slot inside a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
-
(AWS.Response)
—
Returns:
createTestSetDiscrepancyReport(params = {}, callback) ⇒ AWS.Request
Create a report that describes the differences between the bot and the test set.
Service Reference:
Examples:
Calling the createTestSetDiscrepancyReport operation
var params = { target: { /* required */ botAliasTarget: { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ } }, testSetId: 'STRING_VALUE' /* required */ }; lexmodelsv2.createTestSetDiscrepancyReport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The test set Id for the test set discrepancy report.
target
— (map
)The target bot for the test set discrepancy report.
botAliasTarget
— (map
)Contains information about the bot alias used as the resource for the test set discrepancy report.
botId
— required — (String
)The unique identifier for the bot alias.
botAliasId
— required — (String
)The unique identifier for the bot associated with the bot alias.
localeId
— required — (String
)The unique identifier of the locale associated with the bot alias.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetDiscrepancyReportId
— (String
)The unique identifier of the test set discrepancy report to describe.
creationDateTime
— (Date
)The creation date and time for the test set discrepancy report.
testSetId
— (String
)The test set Id for the test set discrepancy report.
target
— (map
)The target bot for the test set discrepancy report.
botAliasTarget
— (map
)Contains information about the bot alias used as the resource for the test set discrepancy report.
botId
— required — (String
)The unique identifier for the bot alias.
botAliasId
— required — (String
)The unique identifier for the bot associated with the bot alias.
localeId
— required — (String
)The unique identifier of the locale associated with the bot alias.
-
(AWS.Response)
—
Returns:
createUploadUrl(params = {}, callback) ⇒ AWS.Request
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
Service Reference:
Examples:
Calling the createUploadUrl operation
var params = { }; lexmodelsv2.createUploadUrl(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
- params (Object) (defaults to: {})
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importId
— (String
)An identifier for a unique import job. Use it when you call the StartImport operation.
uploadUrl
— (String
)A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.
-
(AWS.Response)
—
Returns:
deleteBot(params = {}, callback) ⇒ AWS.Request
Deletes all versions of a bot, including the
Draft
version. To delete a specific version, use theDeleteBotVersion
operation.When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the
DeleteBot
operation returns aResourceInUseException
exception. If you want to delete the bot and the alias, set theskipResourceInUseCheck
parameter totrue
.Service Reference:
Examples:
Calling the deleteBot operation
var params = { botId: 'STRING_VALUE', /* required */ skipResourceInUseCheck: true || false }; lexmodelsv2.deleteBot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to delete.
skipResourceInUseCheck
— (Boolean
)By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException
exception if the bot is being used by another resource. Set this parameter totrue
to skip this check and remove the bot even if it is being used by another resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot that Amazon Lex is deleting.
botStatus
— (String
)The current status of the bot. The status is
Possible values include:Deleting
while the bot and its associated resources are being deleted."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
-
(AWS.Response)
—
Returns:
deleteBotAlias(params = {}, callback) ⇒ AWS.Request
Deletes the specified bot alias.
Service Reference:
Examples:
Calling the deleteBotAlias operation
var params = { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ skipResourceInUseCheck: true || false }; lexmodelsv2.deleteBotAlias(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botAliasId
— (String
)The unique identifier of the bot alias to delete.
botId
— (String
)The unique identifier of the bot associated with the alias to delete.
skipResourceInUseCheck
— (Boolean
)By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a
ResourceInUseException
exception if the alias is being used by another resource. Set this parameter totrue
to skip this check and remove the alias even if it is being used by another resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasId
— (String
)The unique identifier of the bot alias to delete.
botId
— (String
)The unique identifier of the bot that contains the alias to delete.
botAliasStatus
— (String
)The current status of the alias. The status is
Possible values include:Deleting
while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by theListBotAliases
operation."Creating"
"Available"
"Deleting"
"Failed"
-
(AWS.Response)
—
Returns:
deleteBotLocale(params = {}, callback) ⇒ AWS.Request
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
Service Reference:
Examples:
Calling the deleteBotLocale operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteBotLocale(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the locale.
botVersion
— (String
)The version of the bot that contains the locale.
localeId
— (String
)The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contained the deleted locale.
botVersion
— (String
)The version of the bot that contained the deleted locale.
localeId
— (String
)The language and locale of the deleted locale.
botLocaleStatus
— (String
)The status of deleting the bot locale. The locale first enters the
Possible values include:Deleting
status. Once the locale is deleted it no longer appears in the list of locales for the bot."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
-
(AWS.Response)
—
Returns:
deleteBotReplica(params = {}, callback) ⇒ AWS.Request
The action to delete the replicated bot in the secondary region.
Service Reference:
Examples:
Calling the deleteBotReplica operation
var params = { botId: 'STRING_VALUE', /* required */ replicaRegion: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteBotReplica(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique ID of the replicated bot to be deleted from the secondary region
replicaRegion
— (String
)The secondary region of the replicated bot that will be deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique bot ID of the replicated bot generated.
replicaRegion
— (String
)The region of the replicated bot generated.
botReplicaStatus
— (String
)The operational status of the replicated bot generated.
Possible values include:"Enabling"
"Enabled"
"Deleting"
"Failed"
-
(AWS.Response)
—
Returns:
deleteBotVersion(params = {}, callback) ⇒ AWS.Request
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
Service Reference:
Examples:
Calling the deleteBotVersion operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ skipResourceInUseCheck: true || false }; lexmodelsv2.deleteBotVersion(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot that contains the version.
botVersion
— (String
)The version of the bot to delete.
skipResourceInUseCheck
— (Boolean
)By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException
exception if the version is being used by another resource. Set this parameter totrue
to skip this check and remove the version even if it is being used by another resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that is being deleted.
botVersion
— (String
)The version of the bot that is being deleted.
botStatus
— (String
)The current status of the bot.
Possible values include:"Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
-
(AWS.Response)
—
Returns:
deleteCustomVocabulary(params = {}, callback) ⇒ AWS.Request
Removes a custom vocabulary from the specified locale in the specified bot.
Service Reference:
Examples:
Calling the deleteCustomVocabulary operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteCustomVocabulary(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot to remove the custom vocabulary from.
botVersion
— (String
)The version of the bot to remove the custom vocabulary from.
localeId
— (String
)The locale identifier for the locale that contains the custom vocabulary to remove.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that the custom vocabulary was removed from.
botVersion
— (String
)The version of the bot that the custom vocabulary was removed from.
localeId
— (String
)The locale identifier for the locale that the custom vocabulary was removed from.
customVocabularyStatus
— (String
)The status of removing the custom vocabulary.
Possible values include:"Ready"
"Deleting"
"Exporting"
"Importing"
"Creating"
-
(AWS.Response)
—
Returns:
deleteExport(params = {}, callback) ⇒ AWS.Request
Removes a previous export and the associated files stored in an S3 bucket.
Service Reference:
Examples:
Calling the deleteExport operation
var params = { exportId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteExport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
exportId
— (String
)The unique identifier of the export to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:exportId
— (String
)The unique identifier of the deleted export.
exportStatus
— (String
)The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.
Possible values include:"InProgress"
"Completed"
"Failed"
"Deleting"
-
(AWS.Response)
—
Returns:
deleteImport(params = {}, callback) ⇒ AWS.Request
Removes a previous import and the associated file stored in an S3 bucket.
Service Reference:
Examples:
Calling the deleteImport operation
var params = { importId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteImport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
importId
— (String
)The unique identifier of the import to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importId
— (String
)The unique identifier of the deleted import.
importStatus
— (String
)The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.
Possible values include:"InProgress"
"Completed"
"Failed"
"Deleting"
-
(AWS.Response)
—
Returns:
deleteIntent(params = {}, callback) ⇒ AWS.Request
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
Service Reference:
Examples:
Calling the deleteIntent operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteIntent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
intentId
— (String
)The unique identifier of the intent to delete.
botId
— (String
)The identifier of the bot associated with the intent.
botVersion
— (String
)The version of the bot associated with the intent.
localeId
— (String
)The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.
Service Reference:
Examples:
Calling the deleteResourcePolicy operation
var params = { resourceArn: 'STRING_VALUE', /* required */ expectedRevisionId: 'STRING_VALUE' }; lexmodelsv2.deleteResourcePolicy(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.
expectedRevisionId
— (String
)The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception
If you don't specify a revision ID, Amazon Lex will delete the current policy.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
deleteResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request
Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.
You need to add the
DeleteResourcePolicy
orUpdateResourcePolicy
action to the bot role in order to call the API.Service Reference:
Examples:
Calling the deleteResourcePolicyStatement operation
var params = { resourceArn: 'STRING_VALUE', /* required */ statementId: 'STRING_VALUE', /* required */ expectedRevisionId: 'STRING_VALUE' }; lexmodelsv2.deleteResourcePolicyStatement(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
statementId
— (String
)The name of the statement (SID) to delete from the policy.
expectedRevisionId
— (String
)The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex removes the current contents of the statement.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
deleteSlot(params = {}, callback) ⇒ AWS.Request
Deletes the specified slot from an intent.
Service Reference:
Examples:
Calling the deleteSlot operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteSlot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotId
— (String
)The identifier of the slot to delete.
botId
— (String
)The identifier of the bot associated with the slot to delete.
botVersion
— (String
)The version of the bot associated with the slot to delete.
localeId
— (String
)The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
intentId
— (String
)The identifier of the intent associated with the slot.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteSlotType(params = {}, callback) ⇒ AWS.Request
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a
ResourceInUseException
exception. To avoid the exception, set theskipResourceInUseCheck
parameter totrue
.Service Reference:
Examples:
Calling the deleteSlotType operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotTypeId: 'STRING_VALUE', /* required */ skipResourceInUseCheck: true || false }; lexmodelsv2.deleteSlotType(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotTypeId
— (String
)The identifier of the slot type to delete.
botId
— (String
)The identifier of the bot associated with the slot type.
botVersion
— (String
)The version of the bot associated with the slot type.
localeId
— (String
)The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
skipResourceInUseCheck
— (Boolean
)By default, the
DeleteSlotType
operations throws aResourceInUseException
exception if you try to delete a slot type used by a slot. Set theskipResourceInUseCheck
parameter totrue
to skip this check and remove the slot type even if a slot uses it.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteTestSet(params = {}, callback) ⇒ AWS.Request
The action to delete the selected test set.
Service Reference:
Examples:
Calling the deleteTestSet operation
var params = { testSetId: 'STRING_VALUE' /* required */ }; lexmodelsv2.deleteTestSet(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The test set Id of the test set to be deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteUtterances(params = {}, callback) ⇒ AWS.Request
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..
Use the
DeleteUtterances
operation to manually delete utterances for a specific session. When you use theDeleteUtterances
operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with theListAggregatedUtterances
operation are deleted after 15 days.Service Reference:
Examples:
Calling the deleteUtterances operation
var params = { botId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', sessionId: 'STRING_VALUE' }; lexmodelsv2.deleteUtterances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the utterances.
localeId
— (String
)The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.
sessionId
— (String
)The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
describeBot(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a bot.
Service Reference:
Examples:
Calling the describeBot operation
var params = { botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot.
botName
— (String
)The name of the bot.
description
— (String
)The description of the bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
dataPrivacy
— (map
)Settings for managing data privacy of the bot and its conversations with users.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
botStatus
— (String
)The current status of the bot. When the status is
Possible values include:Available
the bot is ready to be used in conversations with users."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp of the date and time that the bot was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot was last updated.
botType
— (String
)The type of the bot that was described.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bots in the network that was described.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
failureReasons
— (Array<String>
)If the
botStatus
isFailed
, this contains a list of reasons that the bot couldn't be built.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeBotAlias(params = {}, callback) ⇒ AWS.Request
Get information about a specific bot alias.
Service Reference:
Examples:
Calling the describeBotAlias operation
var params = { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotAlias(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botAliasId
— (String
)The identifier of the bot alias to describe.
botId
— (String
)The identifier of the bot associated with the bot alias to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasId
— (String
)The identifier of the bot alias.
botAliasName
— (String
)The name of the bot alias.
description
— (String
)The description of the bot alias.
botVersion
— (String
)The version of the bot associated with the bot alias.
botAliasLocaleSettings
— (map<map>
)The locale settings that are unique to the alias.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botAliasHistoryEvents
— (Array<map>
)A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
botVersion
— (String
)The version of the bot that was used in the event.
startDate
— (Date
)The date and time that the event started.
endDate
— (Date
)The date and time that the event ended.
botAliasStatus
— (String
)The current status of the alias. When the alias is
Possible values include:Available
, the alias is ready for use with your bot."Creating"
"Available"
"Deleting"
"Failed"
botId
— (String
)The identifier of the bot associated with the bot alias.
creationDateTime
— (Date
)A timestamp of the date and time that the alias was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the alias was last updated.
parentBotNetworks
— (Array<map>
)A list of the networks to which the bot alias you described belongs.
botId
— required — (String
)The identifier of the network of bots assigned by Amazon Lex.
botVersion
— required — (String
)The version of the network of bots.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeBotLocale(params = {}, callback) ⇒ AWS.Request
Describes the settings that a bot has for a specific locale.
Service Reference:
Examples:
Calling the describeBotLocale operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotLocale(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the described locale.
localeName
— (String
)The name of the locale.
description
— (String
)The description of the locale.
nluIntentConfidenceThreshold
— (Float
)The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
intentsCount
— (Integer
)The number of intents defined for the locale.
slotTypesCount
— (Integer
)The number of slot types defined for the locale.
botLocaleStatus
— (String
)The status of the bot. If the status is
Possible values include:Failed
, the reasons for the failure are listed in thefailureReasons
field."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
failureReasons
— (Array<String>
)if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.creationDateTime
— (Date
)The date and time that the locale was created.
lastUpdatedDateTime
— (Date
)The date and time that the locale was last updated.
lastBuildSubmittedDateTime
— (Date
)The date and time that the locale was last submitted for building.
botLocaleHistoryEvents
— (Array<map>
)History of changes, such as when a locale is used in an alias, that have taken place for the locale.
event
— required — (String
)A description of the event that occurred.
eventDate
— required — (Date
)A timestamp of the date and time that the event occurred.
recommendedActions
— (Array<String>
)Recommended actions to take to resolve an error in the
failureReasons
field.generativeAISettings
— (map
)Contains settings for Amazon Bedrock's generative AI features for your bot locale.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeBotRecommendation(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
Service Reference:
Examples:
Calling the describeBotRecommendation operation
var params = { botId: 'STRING_VALUE', /* required */ botRecommendationId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotRecommendation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot associated with the bot recommendation.
botVersion
— (String
)The version of the bot associated with the bot recommendation.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
botRecommendationId
— (String
)The identifier of the bot recommendation to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with the bot recommendation.
botVersion
— (String
)The version of the bot associated with the bot recommendation.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to describe.
botRecommendationStatus
— (String
)The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Possible values include:"Processing"
"Deleting"
"Deleted"
"Downloading"
"Updating"
"Available"
"Failed"
"Stopping"
"Stopped"
botRecommendationId
— (String
)The identifier of the bot recommendation being described.
failureReasons
— (Array<String>
)If botRecommendationStatus is Failed, Amazon Lex explains why.
creationDateTime
— (Date
)The date and time that the bot recommendation was created.
lastUpdatedDateTime
— (Date
)The date and time that the bot recommendation was last updated.
transcriptSourceSetting
— (map
)The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource
— (map
)Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName
— required — (String
)The name of the bucket containing the transcript and the associated metadata.
pathFormat
— (map
)The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes
— (Array<String>
)A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
transcriptFormat
— required — (String
)The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
Possible values include:"Lex"
transcriptFilter
— (map
)The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter
— (map
)The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter
— (map
)The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime
— required — (Date
)A timestamp indicating the start date for the date range filter.
endDateTime
— required — (Date
)A timestamp indicating the end date for the date range filter.
kmsKeyArn
— (String
)The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting
— (map
)The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn
— (String
)The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword
— (String
)The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword
— (String
)The password used to encrypt the associated transcript file.
botRecommendationResults
— (map
)The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
botLocaleExportUrl
— (String
)The presigned URL link of the recommended bot definition.
associatedTranscriptsUrl
— (String
)The presigned url link of the associated transcript.
statistics
— (map
)The statistical summary of the bot recommendation results.
intents
— (map
)Statistical information about about the intents associated with the bot recommendation results.
discoveredIntentCount
— (Integer
)The number of recommended intents associated with the bot recommendation.
slotTypes
— (map
)Statistical information about the slot types associated with the bot recommendation results.
discoveredSlotTypeCount
— (Integer
)The number of recommended slot types associated with the bot recommendation.
-
(AWS.Response)
—
Returns:
describeBotReplica(params = {}, callback) ⇒ AWS.Request
Monitors the bot replication status through the UI console.
Service Reference:
Examples:
Calling the describeBotReplica operation
var params = { botId: 'STRING_VALUE', /* required */ replicaRegion: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotReplica(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The request for the unique bot ID of the replicated bot being monitored.
replicaRegion
— (String
)The request for the region of the replicated bot being monitored.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique bot ID of the replicated bot being monitored.
replicaRegion
— (String
)The region of the replicated bot being monitored.
sourceRegion
— (String
)The source region of the replicated bot being monitored.
creationDateTime
— (Date
)The creation date and time of the replicated bot being monitored.
botReplicaStatus
— (String
)The operational status of the replicated bot being monitored.
Possible values include:"Enabling"
"Enabled"
"Deleting"
"Failed"
failureReasons
— (Array<String>
)The failure reasons the bot being monitored failed to replicate.
-
(AWS.Response)
—
Returns:
describeBotResourceGeneration(params = {}, callback) ⇒ AWS.Request
Returns information about a request to generate a bot through natural language description, made through the
StartBotResource
API. Use thegeneratedBotLocaleUrl
to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.Service Reference:
Examples:
Calling the describeBotResourceGeneration operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ generationId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotResourceGeneration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot for which to return the generation details.
botVersion
— (String
)The version of the bot for which to return the generation details.
localeId
— (String
)The locale of the bot for which to return the generation details.
generationId
— (String
)The unique identifier of the generation request for which to return the generation details.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot for which the generation request was made.
botVersion
— (String
)The version of the bot for which the generation request was made.
localeId
— (String
)The locale of the bot for which the generation request was made.
generationId
— (String
)The generation ID for which to return the generation details.
failureReasons
— (Array<String>
)A list of reasons why the generation of bot resources through natural language description failed.
generationStatus
— (String
)The status of the generation request.
Possible values include:"Failed"
"Complete"
"InProgress"
generationInputPrompt
— (String
)The prompt used in the generation request.
generatedBotLocaleUrl
— (String
)The Amazon S3 location of the generated bot locale configuration.
creationDateTime
— (Date
)The date and time at which the item was generated.
modelArn
— (String
)The ARN of the model used to generate the bot resources.
lastUpdatedDateTime
— (Date
)The date and time at which the generated item was updated.
-
(AWS.Response)
—
Returns:
describeBotVersion(params = {}, callback) ⇒ AWS.Request
Provides metadata about a version of a bot.
Service Reference:
Examples:
Calling the describeBotVersion operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeBotVersion(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot containing the version to return metadata for.
botVersion
— (String
)The version of the bot to return metadata for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the version.
botName
— (String
)The name of the bot that contains the version.
botVersion
— (String
)The version of the bot that was described.
description
— (String
)The description specified for the bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
dataPrivacy
— (map
)Data privacy settings for the bot version.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
botStatus
— (String
)The current status of the bot. When the status is
Possible values include:Available
, the bot version is ready for use."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
failureReasons
— (Array<String>
)If the
botStatus
isFailed
, this contains a list of reasons that the version couldn't be built.creationDateTime
— (Date
)A timestamp of the date and time that the bot version was created.
parentBotNetworks
— (Array<map>
)A list of the networks to which the bot version you described belongs.
botId
— required — (String
)The identifier of the network of bots assigned by Amazon Lex.
botVersion
— required — (String
)The version of the network of bots.
botType
— (String
)The type of the bot in the version that was described.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The members of bot network in the version that was described.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeCustomVocabularyMetadata(params = {}, callback) ⇒ AWS.Request
Provides metadata information about a custom vocabulary.
Service Reference:
Examples:
Calling the describeCustomVocabularyMetadata operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeCustomVocabularyMetadata(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the custom vocabulary.
botVersion
— (String
)The bot version of the bot to return metadata for.
localeId
— (String
)The locale to return the custom vocabulary information for. The locale must be
en_GB
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the custom vocabulary.
botVersion
— (String
)The version of the bot that contains the custom vocabulary to describe.
localeId
— (String
)The locale that contains the custom vocabulary to describe.
customVocabularyStatus
— (String
)The status of the custom vocabulary. If the status is
Possible values include:Ready
the custom vocabulary is ready to use."Ready"
"Deleting"
"Exporting"
"Importing"
"Creating"
creationDateTime
— (Date
)The date and time that the custom vocabulary was created.
lastUpdatedDateTime
— (Date
)The date and time that the custom vocabulary was last updated.
-
(AWS.Response)
—
Returns:
describeExport(params = {}, callback) ⇒ AWS.Request
Gets information about a specific export.
Service Reference:
Examples:
Calling the describeExport operation
var params = { exportId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeExport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
exportId
— (String
)The unique identifier of the export to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:exportId
— (String
)The unique identifier of the described export.
resourceSpecification
— (map
)The bot, bot ID, and optional locale ID of the exported bot or bot locale.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format used in the files that describe the resource.
Possible values include:"LexJson"
"TSV"
"CSV"
exportStatus
— (String
)The status of the export. When the status is
Possible values include:Complete
the export archive file is available for download."InProgress"
"Completed"
"Failed"
"Deleting"
failureReasons
— (Array<String>
)If the
exportStatus
is failed, contains one or more reasons why the export could not be completed.downloadUrl
— (String
)A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the
DescribeExport
operation.creationDateTime
— (Date
)The date and time that the export was created.
lastUpdatedDateTime
— (Date
)The last date and time that the export was updated.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeImport(params = {}, callback) ⇒ AWS.Request
Gets information about a specific import.
Service Reference:
Examples:
Calling the describeImport operation
var params = { importId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeImport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
importId
— (String
)The unique identifier of the import to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importId
— (String
)The unique identifier of the described import.
resourceSpecification
— (map
)The specifications of the imported bot, bot locale, or custom vocabulary.
botImportSpecification
— (map
)Parameters for importing a bot.
botName
— required — (String
)The name that Amazon Lex should use for the bot.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy
— required — (map
)By default, data stored by Amazon Lex is encrypted. The
DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags
— (map<String>
)A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation.testBotAliasTags
— (map<String>
)A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
botLocaleImportSpecification
— (map
)Parameters for importing a bot locale.
botId
— required — (String
)The identifier of the bot to import the locale to.
botVersion
— required — (String
)The version of the bot to import the locale to. This can only be the
DRAFT
version of the bot.localeId
— required — (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold
— (Float
)Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voiceSettings
— (map
)Defines settings for using an Amazon Polly voice to communicate with a user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
customVocabularyImportSpecification
— (map
)Provides the parameters required for importing a custom vocabulary.
botId
— required — (String
)The identifier of the bot to import the custom vocabulary to.
botVersion
— required — (String
)The version of the bot to import the custom vocabulary to.
localeId
— required — (String
)The identifier of the local to import the custom vocabulary to. The value must be
en_GB
.
testSetImportResourceSpecification
— (map
)Specifications for the test set that is imported.
testSetName
— required — (String
)The name of the test set.
description
— (String
)The description of the test set.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation
— required — (map
)Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation
— required — (map
)Contains information about the input location from where test-set should be imported.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket.
s3Path
— required — (String
)The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality
— required — (String
)Specifies whether the test-set being imported contains written or spoken data.
Possible values include:"Text"
"Audio"
testSetTags
— (map<String>
)A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
importedResourceId
— (String
)The unique identifier that Amazon Lex assigned to the resource created by the import.
importedResourceName
— (String
)The name of the imported resource.
mergeStrategy
— (String
)The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
Possible values include:FailOnConflict
existing resources are not overwritten and the import fails."Overwrite"
"FailOnConflict"
"Append"
importStatus
— (String
)The status of the import process. When the status is
Possible values include:Completed
the resource is imported and ready for use."InProgress"
"Completed"
"Failed"
"Deleting"
failureReasons
— (Array<String>
)If the
importStatus
field isFailed
, this provides one or more reasons for the failure.creationDateTime
— (Date
)The date and time that the import was created.
lastUpdatedDateTime
— (Date
)The date and time that the import was last updated.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
describeIntent(params = {}, callback) ⇒ AWS.Request
Returns metadata about an intent.
Service Reference:
Examples:
Calling the describeIntent operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeIntent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
intentId
— (String
)The identifier of the intent to describe.
botId
— (String
)The identifier of the bot associated with the intent.
botVersion
— (String
)The version of the bot associated with the intent.
localeId
— (String
)The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:intentId
— (String
)The unique identifier assigned to the intent when it was created.
intentName
— (String
)The name specified for the intent.
description
— (String
)The description of the intent.
parentIntentSignature
— (String
)The identifier of the built-in intent that this intent is derived from, if any.
sampleUtterances
— (Array<map>
)User utterances that trigger this intent.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook
— (map
)The Lambda function called during each turn of a conversation with the intent.
enabled
— required — (Boolean
)Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook
— (map
)The Lambda function called when the intent is complete and ready for fulfillment.
enabled
— required — (Boolean
)Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification
— (map
)Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the fulfillment code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the fulfillment code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
fulfillmentUpdatesSpecification
— (map
)Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active
— required — (Boolean
)Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required.startResponse
— (map
)Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds
— required — (Integer
)The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt the start message while it is playing.
updateResponse
— (map
)Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds
— required — (Integer
)The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds
— (Integer
)The length of time that the fulfillment Lambda function should run before it times out.
active
— (Boolean
)Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run.
slotPriorities
— (Array<map>
)The list that determines the priority that slots should be elicited from the user.
priority
— required — (Integer
)The priority that Amazon Lex should apply to the slot.
slotId
— required — (String
)The unique identifier of the slot.
intentConfirmationSetting
— (map
)Prompts that Amazon Lex sends to the user to confirm completion of an intent.
promptSpecification
— required — (map
)Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
declinationResponse
— (map
)When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true.confirmationResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
confirmationNextStep
— (map
)Specifies the next step that the bot executes when the customer confirms the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
confirmationConditional
— (map
)A list of conditional branches to evaluate after the intent is closed.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
declinationNextStep
— (map
)Specifies the next step that the bot executes when the customer declines the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
declinationConditional
— (map
)A list of conditional branches to evaluate after the intent is declined.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)The next step to take in the conversation if the confirmation step fails.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
intentClosingSetting
— (map
)The response that Amazon Lex sends to when the intent is closed.
closingResponse
— (map
)The response that Amazon Lex sends to the user when the intent is complete.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true.nextStep
— (map
)Specifies the next step that the bot executes after playing the intent's closing response.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
inputContexts
— (Array<map>
)A list of contexts that must be active for the intent to be considered for sending to the user.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)A list of contexts that are activated when the intent is fulfilled.
name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration
— (map
)Configuration information required to use the
AMAZON.KendraSearchIntent
intent.kendraIndex
— required — (String
)The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot.queryFilterStringEnabled
— (Boolean
)Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.queryFilterString
— (String
)A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
botId
— (String
)The identifier of the bot associated with the intent.
botVersion
— (String
)The version of the bot associated with the intent.
localeId
— (String
)The language and locale specified for the intent.
creationDateTime
— (Date
)A timestamp of the date and time that the intent was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the intent was last updated.
initialResponseSetting
— (map
)Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
initialResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
qnAIntentConfiguration
— (map
)Details about the configuration of the built-in
Amazon.QnAIntent
.dataSourceConfiguration
— (map
)Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.opensearchConfiguration
— (map
)Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.domainEndpoint
— required — (String
)The endpoint of the Amazon OpenSearch Service domain.
indexName
— required — (String
)The name of the Amazon OpenSearch Service index.
exactResponse
— (Boolean
)Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
questionField
— required — (String
)The name of the field that contains the query made to the OpenSearch Service database.
answerField
— required — (String
)The name of the field that contains the answer to the query made to the OpenSearch Service database.
includeFields
— (Array<String>
)Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
kendraConfiguration
— (map
)Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index.kendraIndex
— required — (String
)The ARN of the Amazon Kendra index to use.
queryFilterStringEnabled
— (Boolean
)Specifies whether to enable an Amazon Kendra filter string or not.
queryFilterString
— (String
)Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
exactResponse
— (Boolean
)Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
bedrockKnowledgeStoreConfiguration
— (map
)Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base.bedrockKnowledgeBaseArn
— required — (String
)The base ARN of the knowledge base used.
exactResponse
— (Boolean
)Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
answerField
— (String
)The answer field used for an exact response from Bedrock Knowledge Store.
bedrockModelConfiguration
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
describeResourcePolicy(params = {}, callback) ⇒ AWS.Request
Gets the resource policy and policy revision for a bot or bot alias.
Service Reference:
Examples:
Calling the describeResourcePolicy operation
var params = { resourceArn: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeResourcePolicy(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy
— (String
)The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
describeSlot(params = {}, callback) ⇒ AWS.Request
Gets metadata information about a slot.
Service Reference:
Examples:
Calling the describeSlot operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeSlot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotId
— (String
)The unique identifier for the slot.
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 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.
intentId
— (String
)The identifier of the intent that contains the slot.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (map
)Prompts that Amazon Lex uses to elicit a value for the slot.
defaultValueSpecification
— (map
)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, session attributes, and defined values.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
slotConstraint
— required — (String
)Specifies whether the slot is required or optional.
Possible values include:"Required"
"Optional"
promptSpecification
— (map
)The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)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.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
slotCaptureSetting
— (map
)Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
captureNextStep
— (map
)Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
captureConditional
— (map
)A list of conditional branches to evaluate after the slot value is captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate when the slot value isn't captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)Code hook called when Amazon Lex doesn't capture a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
slotResolutionSetting
— (map
)An object containing information about whether assisted slot resolution is turned on for the slot or not.
slotResolutionStrategy
— required — (String
)Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
Possible values include:EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off."EnhancedFallback"
"Default"
obfuscationSetting
— (map
)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
— required — (String
)Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Possible values include:"None"
"DefaultObfuscation"
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
— (Date
)A timestamp of the date and time that the slot was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the slot was last updated.
multipleValuesSetting
— (map
)Indicates whether the slot accepts multiple values in a single utterance.
If the
multipleValuesSetting
is not set, the default value isfalse
.allowMultipleValues
— (Boolean
)Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, 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 aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
subSlotSetting
— (map
)Specifications for the constituent sub slots and the expression for the composite slot.
expression
— (String
)The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
slotSpecifications
— (map<map>
)Specifications for the constituent sub slots of a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to the slot type.
valueElicitationSetting
— required — (map
)Specifies the elicitation setting details for constituent sub slots of a composite slot.
defaultValueSpecification
— (map
)Defines a list of values that Amazon Lex should use as the default value for a slot.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
promptSpecification
— required — (map
)Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots.utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
-
(AWS.Response)
—
Returns:
describeSlotType(params = {}, callback) ⇒ AWS.Request
Gets metadata information about a slot type.
Service Reference:
Examples:
Calling the describeSlotType operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotTypeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeSlotType(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotTypeId
— (String
)The identifier of the slot type.
botId
— (String
)The identifier of the bot associated with the slot type.
botVersion
— (String
)The version of the bot associated with the slot type.
localeId
— (String
)The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:slotTypeId
— (String
)The unique identifier for the slot type.
slotTypeName
— (String
)The name specified for the slot type.
description
— (String
)The description specified for the slot type.
slotTypeValues
— (Array<map>
)The values that the slot type can take. Includes any synonyms for the slot type values.
sampleValue
— (map
)The value of the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
synonyms
— (Array<map>
)Additional values related to the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
valueSelectionSetting
— (map
)The strategy that Amazon Lex uses to choose a value from a list of possible values.
resolutionStrategy
— required — (String
)Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
Possible values include:valueSelectionStrategy
, the default isORIGINAL_VALUE
."OriginalValue"
"TopResolution"
"Concatenation"
-
regexFilter
— (map
)A regular expression used to validate the value of a slot.
pattern
— required — (String
)A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or
{x,}
with no upper bound. -
Wild card (.)
-
advancedRecognitionSetting
— (map
)Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
audioRecognitionStrategy
— (String
)Enables using the slot values as a custom vocabulary for recognizing user utterances.
Possible values include:"UseSlotValuesAsCustomVocabulary"
parentSlotTypeSignature
— (String
)The built in slot type used as a parent to this slot type.
botId
— (String
)The identifier of the bot associated with the slot type.
botVersion
— (String
)The version of the bot associated with the slot type.
localeId
— (String
)The language and locale specified for the slot type.
creationDateTime
— (Date
)A timestamp of the date and time that the slot type was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the slot type was last updated.
externalSourceSetting
— (map
)Provides information about the external source of the slot type's definition.
grammarSlotTypeSetting
— (map
)Settings required for a slot type based on a grammar that you provide.
source
— (map
)The source of the grammar used to create the slot type.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket that contains the grammar source.
s3ObjectKey
— required — (String
)The path to the grammar in the Amazon S3 bucket.
kmsKeyArn
— (String
)The KMS key required to decrypt the contents of the grammar, if any.
compositeSlotTypeSetting
— (map
)Specifications for a composite slot type.
subSlots
— (Array<map>
)Subslots in the composite slot.
name
— required — (String
)Name of a constituent sub slot inside a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
-
(AWS.Response)
—
Returns:
describeTestExecution(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test execution.
Service Reference:
Examples:
Calling the describeTestExecution operation
var params = { testExecutionId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeTestExecution(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testExecutionId
— (String
)The execution Id of the test set execution.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testExecutionId
— (String
)The execution Id for the test set execution.
creationDateTime
— (Date
)The execution creation date and time for the test set execution.
lastUpdatedDateTime
— (Date
)The date and time of the last update for the execution.
testExecutionStatus
— (String
)The test execution status for the test execution.
Possible values include:"Pending"
"Waiting"
"InProgress"
"Completed"
"Failed"
"Stopping"
"Stopped"
testSetId
— (String
)The test set Id for the test set execution.
testSetName
— (String
)The test set name of the test set execution.
target
— (map
)The target bot for the test set execution details.
botAliasTarget
— (map
)Contains information about the bot alias used for the test execution.
botId
— required — (String
)The bot Id of the bot alias used in the test set execution.
botAliasId
— required — (String
)The bot alias Id of the bot alias used in the test set execution.
localeId
— required — (String
)The locale Id of the bot alias used in the test set execution.
apiMode
— (String
)Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming,
Possible values include:StartConversation
Amazon Lex Runtime API is used. Whereas for non-streaming,RecognizeUtterance
andRecognizeText
Amazon Lex Runtime API is used."Streaming"
"NonStreaming"
testExecutionModality
— (String
)Indicates whether test set is audio or text.
Possible values include:"Text"
"Audio"
failureReasons
— (Array<String>
)Reasons for the failure of the test set execution.
-
(AWS.Response)
—
Returns:
describeTestSet(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set.
Service Reference:
Examples:
Calling the describeTestSet operation
var params = { testSetId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeTestSet(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The test set Id for the test set request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetId
— (String
)The test set Id for the test set response.
testSetName
— (String
)The test set name of the test set.
description
— (String
)The description of the test set.
modality
— (String
)Indicates whether the test set is audio or text data.
Possible values include:"Text"
"Audio"
status
— (String
)The status of the test set.
Possible values include:"Importing"
"PendingAnnotation"
"Deleting"
"ValidationError"
"Ready"
roleArn
— (String
)The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
numTurns
— (Integer
)The total number of agent and user turn in the test set.
storageLocation
— (map
)The Amazon S3 storage location for the test set data.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
creationDateTime
— (Date
)The creation date and time for the test set data.
lastUpdatedDateTime
— (Date
)The date and time for the last update of the test set data.
-
(AWS.Response)
—
Returns:
describeTestSetDiscrepancyReport(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set discrepancy report.
Service Reference:
Examples:
Calling the describeTestSetDiscrepancyReport operation
var params = { testSetDiscrepancyReportId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeTestSetDiscrepancyReport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetDiscrepancyReportId
— (String
)The unique identifier of the test set discrepancy report.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetDiscrepancyReportId
— (String
)The unique identifier of the test set discrepancy report to describe.
testSetId
— (String
)The test set Id for the test set discrepancy report.
creationDateTime
— (Date
)The time and date of creation for the test set discrepancy report.
target
— (map
)The target bot location for the test set discrepancy report.
botAliasTarget
— (map
)Contains information about the bot alias used as the resource for the test set discrepancy report.
botId
— required — (String
)The unique identifier for the bot alias.
botAliasId
— required — (String
)The unique identifier for the bot associated with the bot alias.
localeId
— required — (String
)The unique identifier of the locale associated with the bot alias.
testSetDiscrepancyReportStatus
— (String
)The status for the test set discrepancy report.
Possible values include:"InProgress"
"Completed"
"Failed"
lastUpdatedDataTime
— (Date
)The date and time of the last update for the test set discrepancy report.
testSetDiscrepancyTopErrors
— (map
)The top 200 error results from the test set discrepancy report.
intentDiscrepancies
— required — (Array<map>
)Contains information about discrepancies found for intents between the test set and the bot.
intentName
— required — (String
)The name of the intent in the discrepancy report.
errorMessage
— required — (String
)The error message for a discrepancy for an intent between the test set and the bot.
slotDiscrepancies
— required — (Array<map>
)Contains information about discrepancies found for slots between the test set and the bot.
intentName
— required — (String
)The name of the intent associated with the slot in the discrepancy report.
slotName
— required — (String
)The name of the slot in the discrepancy report.
errorMessage
— required — (String
)The error message for a discrepancy for an intent between the test set and the bot.
testSetDiscrepancyRawOutputUrl
— (String
)Pre-signed Amazon S3 URL to download the test set discrepancy report.
failureReasons
— (Array<String>
)The failure report for the test set discrepancy report generation action.
-
(AWS.Response)
—
Returns:
describeTestSetGeneration(params = {}, callback) ⇒ AWS.Request
Gets metadata information about the test set generation.
Service Reference:
Examples:
Calling the describeTestSetGeneration operation
var params = { testSetGenerationId: 'STRING_VALUE' /* required */ }; lexmodelsv2.describeTestSetGeneration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetGenerationId
— (String
)The unique identifier of the test set generation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetGenerationId
— (String
)The unique identifier of the test set generation.
testSetGenerationStatus
— (String
)The status for the test set generation.
Possible values include:"Generating"
"Ready"
"Failed"
"Pending"
failureReasons
— (Array<String>
)The reasons the test set generation failed.
testSetId
— (String
)The unique identifier for the test set created for the generated test set.
testSetName
— (String
)The test set name for the generated test set.
description
— (String
)The test set description for the test set generation.
storageLocation
— (map
)The Amazon S3 storage location for the test set generation.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
generationDataSource
— (map
)The data source of the test set used for the test set generation.
conversationLogsDataSource
— (map
)Contains information about the bot from which the conversation logs are sourced.
botId
— required — (String
)The bot Id from the conversation logs.
botAliasId
— required — (String
)The bot alias Id from the conversation logs.
localeId
— required — (String
)The locale Id of the conversation log.
filter
— required — (map
)The filter for the data source of the conversation log.
startTime
— required — (Date
)The start time for the conversation log.
endTime
— required — (Date
)The end time for the conversation log.
inputMode
— required — (String
)The selection to filter by input mode for the conversation logs.
Possible values include:"Speech"
"Text"
roleArn
— (String
)The roleARN of the test set used for the test set generation.
creationDateTime
— (Date
)The creation date and time for the test set generation.
lastUpdatedDateTime
— (Date
)The date and time of the last update for the test set generation.
-
(AWS.Response)
—
Returns:
generateBotElement(params = {}, callback) ⇒ AWS.Request
Generates sample utterances for an intent.
Service Reference:
Examples:
Calling the generateBotElement operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.generateBotElement(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
intentId
— (String
)The intent unique Id for the bot request to generate utterances.
botId
— (String
)The bot unique Id for the bot request to generate utterances.
botVersion
— (String
)The bot version for the bot request to generate utterances.
localeId
— (String
)The unique locale Id for the bot request to generate utterances.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique bot Id for the bot which received the response.
botVersion
— (String
)The unique bot version for the bot which received the response.
localeId
— (String
)The unique locale Id for the bot which received the response.
intentId
— (String
)The unique intent Id for the bot which received the response.
sampleUtterances
— (Array<map>
)The sample utterances for the bot which received the response.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
-
(AWS.Response)
—
Returns:
getTestExecutionArtifactsUrl(params = {}, callback) ⇒ AWS.Request
The pre-signed Amazon S3 URL to download the test execution result artifacts.
Service Reference:
Examples:
Calling the getTestExecutionArtifactsUrl operation
var params = { testExecutionId: 'STRING_VALUE' /* required */ }; lexmodelsv2.getTestExecutionArtifactsUrl(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testExecutionId
— (String
)The unique identifier of the completed test execution.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testExecutionId
— (String
)The unique identifier of the completed test execution.
downloadArtifactsUrl
— (String
)The pre-signed Amazon S3 URL to download completed test execution.
-
(AWS.Response)
—
Returns:
listAggregatedUtterances(params = {}, callback) ⇒ AWS.Request
Provides a list of utterances that users have sent to the bot.
Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.
You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.
Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.
Utterances statistics are not generated under the following conditions:
-
The
childDirected
field was set to true when the bot was created. -
You are using slot obfuscation with one or more slots.
-
You opted out of participating in improving Amazon Lex.
Service Reference:
Examples:
Calling the listAggregatedUtterances operation
var params = { aggregationDuration: { /* required */ relativeAggregationDuration: { /* required */ timeDimension: Hours | Days | Weeks, /* required */ timeValue: 'NUMBER_VALUE' /* required */ } }, botId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ botAliasId: 'STRING_VALUE', botVersion: 'STRING_VALUE', filters: [ { name: Utterance, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: HitCount | MissedCount, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listAggregatedUtterances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot associated with this request.
botAliasId
— (String
)The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
botVersion
— (String
)The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
localeId
— (String
)The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
aggregationDuration
— (map
)The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
relativeAggregationDuration
— required — (map
)The desired time window for aggregating utterances.
timeDimension
— required — (String
)The type of time period that the
Possible values include:timeValue
field represents."Hours"
"Days"
"Weeks"
timeValue
— required — (Integer
)The period of the time window to gather statistics for. The valid value depends on the setting of the
timeDimension
field.-
Hours
- 1/3/6/12/24 -
Days
- 3 -
Weeks
- 1/2
-
sortBy
— (map
)Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
attribute
— required — (String
)The utterance attribute to sort by.
Possible values include:"HitCount"
"MissedCount"
order
— required — (String
)Specifies whether to sort the aggregated utterances in ascending or descending order.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
name
— required — (String
)The name of the field to filter the utterance list.
Possible values include:"Utterance"
values
— required — (Array<String>
)The value to use for filtering the list of bots.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListAggregatedUtterances
operation should return only utterances that equal the specified value. SpecifyCO
when theListAggregatedUtterances
operation should return utterances that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the
maxResults
parameter, 1,000 results are returned.nextToken
— (String
)If the response from the
ListAggregatedUtterances
operation contains more results that specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the utterances.
botAliasId
— (String
)The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.
botVersion
— (String
)The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.
localeId
— (String
)The identifier of the language and locale that the utterances are in.
aggregationDuration
— (map
)The time period used to aggregate the utterance data.
relativeAggregationDuration
— required — (map
)The desired time window for aggregating utterances.
timeDimension
— required — (String
)The type of time period that the
Possible values include:timeValue
field represents."Hours"
"Days"
"Weeks"
timeValue
— required — (Integer
)The period of the time window to gather statistics for. The valid value depends on the setting of the
timeDimension
field.-
Hours
- 1/3/6/12/24 -
Days
- 3 -
Weeks
- 1/2
-
aggregationWindowStartTime
— (Date
)The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
aggregationWindowEndTime
— (Date
)The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.
aggregationLastRefreshedDateTime
— (Date
)The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.
-
Hours - for 1 hour time window, every half hour; otherwise every hour.
-
Days - every 6 hours
-
Weeks - for a one week time window, every 12 hours; otherwise, every day
-
aggregatedUtterancesSummaries
— (Array<map>
)Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
utterance
— (String
)The text of the utterance. If the utterance was used with the
RecognizeUtterance
operation, the text is the transcription of the audio utterance.hitCount
— (Integer
)The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.
missedCount
— (Integer
)The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.
utteranceFirstRecordedInAggregationDuration
— (Date
)The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.
utteranceLastRecordedInAggregationDuration
— (Date
)The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.
containsDataFromDeletedResources
— (Boolean
)Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListAggregatedUtterances
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListAggregatedUtterances
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listBotAliases(params = {}, callback) ⇒ AWS.Request
Gets a list of aliases for the specified bot.
Service Reference:
Examples:
Calling the listBotAliases operation
var params = { botId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listBotAliases(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to list aliases for.
maxResults
— (Integer
)The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListBotAliases
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasSummaries
— (Array<map>
)Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more aliases available, thenextToken
field contains a token to get the next page of results.botAliasId
— (String
)The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.
botAliasName
— (String
)The name of the bot alias.
description
— (String
)The description of the bot alias.
botVersion
— (String
)The version of the bot that the bot alias references.
botAliasStatus
— (String
)The current state of the bot alias. If the status is
Possible values include:Available
, the alias is ready for use."Creating"
"Available"
"Deleting"
"Failed"
creationDateTime
— (Date
)A timestamp of the date and time that the bot alias was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot alias was last updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBotAliases
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.botId
— (String
)The identifier of the bot associated with the aliases.
-
(AWS.Response)
—
Returns:
listBotAliasReplicas(params = {}, callback) ⇒ AWS.Request
The action to list the replicated bots created from the source bot alias.
Service Reference:
Examples:
Calling the listBotAliasReplicas operation
var params = { botId: 'STRING_VALUE', /* required */ replicaRegion: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listBotAliasReplicas(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The request for the unique bot ID of the replicated bot created from the source bot alias.
replicaRegion
— (String
)The request for the secondary region of the replicated bot created from the source bot alias.
maxResults
— (Integer
)The request for maximum results to list the replicated bots created from the source bot alias.
nextToken
— (String
)The request for the next token for the replicated bot created from the source bot alias.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique bot ID of the replicated bot created from the source bot alias.
sourceRegion
— (String
)The source region of the replicated bot created from the source bot alias.
replicaRegion
— (String
)The secondary region of the replicated bot created from the source bot alias.
botAliasReplicaSummaries
— (Array<map>
)The summary information of the replicated bot created from the source bot alias.
botAliasId
— (String
)The bot alias ID for all the alias bot replications.
botAliasReplicationStatus
— (String
)The replication statuses for all the alias bot replications.
Possible values include:"Creating"
"Updating"
"Available"
"Deleting"
"Failed"
botVersion
— (String
)The bot version for all the alias bot replications.
creationDateTime
— (Date
)The creation time and date for all the alias bot replications.
lastUpdatedDateTime
— (Date
)The last time and date updated for all the alias bot replications.
failureReasons
— (Array<String>
)The reasons for failure for the aliases bot replications.
nextToken
— (String
)The next token for the replicated bots created from the source bot alias.
-
(AWS.Response)
—
Returns:
listBotLocales(params = {}, callback) ⇒ AWS.Request
Gets a list of locales for the specified bot.
Service Reference:
Examples:
Calling the listBotLocales operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ filters: [ { name: BotLocaleName, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: BotLocaleName, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBotLocales(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to list locales for.
botVersion
— (String
)The version of the bot to list locales for.
sortBy
— (map
)Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
attribute
— required — (String
)The bot locale attribute to sort by.
Possible values include:"BotLocaleName"
order
— required — (String
)Specifies whether to sort the bot locales in ascending or descending order.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
name
— required — (String
)The name of the field to filter the list of bots.
Possible values include:"BotLocaleName"
values
— required — (Array<String>
)The value to use for filtering the list of bots.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListBotLocales
operation should return only aliases that equal the specified value. SpecifyCO
when theListBotLocales
operation should return aliases that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListBotLocales
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token as thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot to list locales for.
botVersion
— (String
)The version of the bot.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBotLocales
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotLocales
operation request to get the next page of results.botLocaleSummaries
— (Array<map>
)Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more locales available, thenextToken
field contains a token to get the next page of results.localeId
— (String
)The language and locale of the bot locale.
localeName
— (String
)The name of the bot locale.
description
— (String
)The description of the bot locale.
botLocaleStatus
— (String
)The current status of the bot locale. When the status is
Possible values include:Built
the locale is ready for use."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot locale was last updated.
lastBuildSubmittedDateTime
— (Date
)A timestamp of the date and time that the bot locale was last built.
-
(AWS.Response)
—
Returns:
listBotRecommendations(params = {}, callback) ⇒ AWS.Request
Get a list of bot recommendations that meet the specified criteria.
Service Reference:
Examples:
Calling the listBotRecommendations operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listBotRecommendations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the bot recommendation list.
botVersion
— (String
)The version of the bot that contains the bot recommendation list.
localeId
— (String
)The identifier of the language and locale of the bot recommendation list.
maxResults
— (Integer
)The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot that contains the bot recommendation list.
botVersion
— (String
)The version of the bot that contains the bot recommendation list.
localeId
— (String
)The identifier of the language and locale of the bot recommendation list.
botRecommendationSummaries
— (Array<map>
)Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
botRecommendationStatus
— required — (String
)The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Possible values include:"Processing"
"Deleting"
"Deleted"
"Downloading"
"Updating"
"Available"
"Failed"
"Stopping"
"Stopped"
botRecommendationId
— required — (String
)The unique identifier of the bot recommendation to be updated.
creationDateTime
— (Date
)A timestamp of the date and time that the bot recommendation was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot recommendation was last updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listBotReplicas(params = {}, callback) ⇒ AWS.Request
The action to list the replicated bots.
Service Reference:
Examples:
Calling the listBotReplicas operation
var params = { botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.listBotReplicas(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The request for the unique bot IDs in the list of replicated bots.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)the unique bot IDs in the list of replicated bots.
sourceRegion
— (String
)The source region of the source bots in the list of replicated bots.
botReplicaSummaries
— (Array<map>
)The summary details for the replicated bots.
replicaRegion
— (String
)The replica region used in the replication statuses summary.
creationDateTime
— (Date
)The creation time and date for the replicated bots.
botReplicaStatus
— (String
)The operation status for the replicated bot applicable.
Possible values include:"Enabling"
"Enabled"
"Deleting"
"Failed"
failureReasons
— (Array<String>
)The reasons for the failure for the replicated bot.
-
(AWS.Response)
—
Returns:
listBotResourceGenerations(params = {}, callback) ⇒ AWS.Request
Lists the generation requests made for a bot locale.
Service Reference:
Examples:
Calling the listBotResourceGenerations operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: creationStartTime | lastUpdatedTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBotResourceGenerations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot whose generation requests you want to view.
botVersion
— (String
)The version of the bot whose generation requests you want to view.
localeId
— (String
)The locale of the bot whose generation requests you want to view.
sortBy
— (map
)An object containing information about the attribute and the method by which to sort the results
attribute
— required — (String
)The attribute by which to sort the generation request information. You can sort by the following attributes.
-
creationStartTime
– The time at which the generation request was created. -
lastUpdatedTime
– The time at which the generation request was last updated.
"creationStartTime"
"lastUpdatedTime"
-
order
— required — (String
)The order by which to sort the generation request information.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of results to return in the response.
nextToken
— (String
)If the total number of results is greater than the number specified in the
maxResults
, the response returns a token in thenextToken
field. Use this token when making a request to return the next batch of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot for which the generation requests were made.
botVersion
— (String
)The version of the bot for which the generation requests were made.
localeId
— (String
)The locale of the bot for which the generation requests were made.
generationSummaries
— (Array<map>
)A list of objects, each containing information about a generation request for the bot locale.
generationId
— (String
)The unique identifier of the generation request.
generationStatus
— (String
)The status of the generation request.
Possible values include:"Failed"
"Complete"
"InProgress"
creationDateTime
— (Date
)The date and time at which the generation request was made.
lastUpdatedDateTime
— (Date
)The date and time at which the generation request was last updated.
nextToken
— (String
)If the total number of results is greater than the number specified in the
maxResults
, the response returns a token in thenextToken
field. Use this token when making a request to return the next batch of results.
-
(AWS.Response)
—
Returns:
listBots(params = {}, callback) ⇒ AWS.Request
Gets a list of available bots.
Service Reference:
Examples:
Calling the listBots operation
var params = { filters: [ { name: BotName | BotType, /* required */ operator: CO | EQ | NE, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: BotName, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBots(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
sortBy
— (map
)Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
attribute
— required — (String
)The attribute to use to sort the list of bots.
Possible values include:"BotName"
order
— required — (String
)The order to sort the list. You can choose ascending or descending.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
name
— required — (String
)The name of the field to filter the list of bots.
Possible values include:"BotName"
"BotType"
values
— required — (Array<String>
)The value to use for filtering the list of bots.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListBots
operation should return only aliases that equal the specified value. SpecifyCO
when theListBots
operation should return aliases that contain the specified value."CO"
"EQ"
"NE"
maxResults
— (Integer
)The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListBots
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListBots
request to return the next page of results. For a complete set of results, call theListBots
operation until thenextToken
returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botSummaries
— (Array<map>
)Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more bots available, thenextToken
field contains a token to the next page of results.botId
— (String
)The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.
botName
— (String
)The name of the bot.
description
— (String
)The description of the bot.
botStatus
— (String
)The current status of the bot. When the status is
Possible values include:Available
the bot is ready for use."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
latestBotVersion
— (String
)The latest numerical version in use for the bot.
lastUpdatedDateTime
— (Date
)The date and time that the bot was last updated.
botType
— (String
)The type of the bot.
Possible values include:"Bot"
"BotNetwork"
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBots
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBots
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listBotVersionReplicas(params = {}, callback) ⇒ AWS.Request
Contains information about all the versions replication statuses applicable for Global Resiliency.
Service Reference:
Examples:
Calling the listBotVersionReplicas operation
var params = { botId: 'STRING_VALUE', /* required */ replicaRegion: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: BotVersion, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBotVersionReplicas(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The request for the unique ID in the list of replicated bots.
replicaRegion
— (String
)The request for the region used in the list of replicated bots.
maxResults
— (Integer
)The maximum results given in the list of replicated bots.
nextToken
— (String
)The next token given in the list of replicated bots.
sortBy
— (map
)The requested sort category for the list of replicated bots.
attribute
— required — (String
)The attribute of the sort category for the version replicated bots.
Possible values include:"BotVersion"
order
— required — (String
)The order of the sort category for the version replicated bots.
Possible values include:"Ascending"
"Descending"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique ID of the bots in the list of replicated bots.
sourceRegion
— (String
)The source region used for the bots in the list of replicated bots.
replicaRegion
— (String
)The region used for the replicated bots in the list of replicated bots.
botVersionReplicaSummaries
— (Array<map>
)The information summary used for the replicated bots in the list of replicated bots.
botVersion
— (String
)The bot version for the summary information for all the version replication statuses.
botVersionReplicationStatus
— (String
)The version replication status for all the replicated bots.
Possible values include:"Creating"
"Available"
"Deleting"
"Failed"
creationDateTime
— (Date
)The creation date and time of the replication status for all the replicated bots.
failureReasons
— (Array<String>
)The reasons for replication failure for all the replicated bots.
nextToken
— (String
)The next token used for the replicated bots in the list of replicated bots.
-
(AWS.Response)
—
Returns:
listBotVersions(params = {}, callback) ⇒ AWS.Request
Gets information about all of the versions of a bot.
The
ListBotVersions
operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, theListBotVersions
operation returns for summaries, one for each numbered version and one for theDRAFT
version.The
ListBotVersions
operation always returns at least one version, theDRAFT
version.Service Reference:
Examples:
Calling the listBotVersions operation
var params = { botId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: BotVersion, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBotVersions(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot to list versions for.
sortBy
— (map
)Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
attribute
— required — (String
)The attribute to use to sort the list of versions.
Possible values include:"BotVersion"
order
— required — (String
)The order to sort the list. You can specify ascending or descending order.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response to the
ListBotVersion
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot to list versions for.
botVersionSummaries
— (Array<map>
)Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more versions available, thenextToken
field contains a token to get the next page of results.botName
— (String
)The name of the bot associated with the version.
botVersion
— (String
)The numeric version of the bot, or
DRAFT
to indicate that this is the version of the bot that can be updated..description
— (String
)The description of the version.
botStatus
— (String
)The status of the bot. When the status is available, the version of the bot is ready for use.
Possible values include:"Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp of the date and time that the version was created.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBotVersions
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listBuiltInIntents(params = {}, callback) ⇒ AWS.Request
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the
parentIntentSignature
parameter when you call theCreateIntent
operation. For more information, see CreateIntent.Service Reference:
Examples:
Calling the listBuiltInIntents operation
var params = { localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: IntentSignature, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBuiltInIntents(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
localeId
— (String
)The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
sortBy
— (map
)Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
attribute
— required — (String
)The attribute to use to sort the list of built-in intents.
Possible values include:"IntentSignature"
order
— required — (String
)The order to sort the list. You can specify ascending or descending order.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListBuiltInIntents
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:builtInIntentSummaries
— (Array<map>
)Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more intents available, thenextToken
field contains a token to get the next page of results.intentSignature
— (String
)The signature of the built-in intent. Use this to specify the parent intent of a derived intent.
description
— (String
)The description of the intent.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBuiltInIntents
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.localeId
— (String
)The language and locale of the intents in the list.
-
(AWS.Response)
—
Returns:
listBuiltInSlotTypes(params = {}, callback) ⇒ AWS.Request
Gets a list of built-in slot types that meet the specified criteria.
Service Reference:
Examples:
Calling the listBuiltInSlotTypes operation
var params = { localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: SlotTypeSignature, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listBuiltInSlotTypes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
localeId
— (String
)The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
sortBy
— (map
)Determines the sort order for the response from the
ListBuiltInSlotTypes
operation. You can choose to sort by the slot type signature in either ascending or descending order.attribute
— required — (String
)The attribute to use to sort the list of built-in intents.
Possible values include:"SlotTypeSignature"
order
— required — (String
)The order to sort the list. You can choose ascending or descending.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListBuiltInSlotTypes
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:builtInSlotTypeSummaries
— (Array<map>
)Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slot types available, thenextToken
field contains a token to get the next page of results.slotTypeSignature
— (String
)The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.
description
— (String
)The description of the built-in slot type.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListBuiltInSlotTypes
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aLIstBuiltInSlotTypes
operation request to get the next page of results.localeId
— (String
)The language and locale of the slot types in the list.
-
(AWS.Response)
—
Returns:
listCustomVocabularyItems(params = {}, callback) ⇒ AWS.Request
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
Service Reference:
Examples:
Calling the listCustomVocabularyItems operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listCustomVocabularyItems(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
botVersion
— (String
)The bot version of the bot to the list custom vocabulary request.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
maxResults
— (Integer
)The maximum number of items returned by the list operation.
nextToken
— (String
)The nextToken identifier to the list custom vocabulary request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with this custom vocabulary.
botVersion
— (String
)The identifier of the version of the bot associated with this custom vocabulary.
localeId
— (String
)The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
customVocabularyItems
— (Array<map>
)The custom vocabulary items from the list custom vocabulary response.
itemId
— required — (String
)The unique item identifer for the custom vocabulary item from the custom vocabulary list.
phrase
— required — (String
)The unique phrase for the custom vocabulary item from the custom vocabulary list.
weight
— (Integer
)The weight assigned for the custom vocabulary item from the custom vocabulary list.
displayAs
— (String
)The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
nextToken
— (String
)The nextToken identifier to the list custom vocabulary response.
-
(AWS.Response)
—
Returns:
listExports(params = {}, callback) ⇒ AWS.Request
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
Service Reference:
Examples:
Calling the listExports operation
var params = { botId: 'STRING_VALUE', botVersion: 'STRING_VALUE', filters: [ { name: ExportResourceType, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], localeId: 'STRING_VALUE', maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listExports(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier that Amazon Lex assigned to the bot.
botVersion
— (String
)The version of the bot to list exports for.
sortBy
— (map
)Determines the field that the list of exports is sorted by. You can sort by the
LastUpdatedDateTime
field in ascending or descending order.attribute
— required — (String
)The export field to use for sorting.
Possible values include:"LastUpdatedDateTime"
order
— required — (String
)The order to sort the list.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
name
— required — (String
)The name of the field to use for filtering.
Possible values include:"ExportResourceType"
values
— required — (Array<String>
)The values to use to filter the response. The values must be
Bot
,BotLocale
, orCustomVocabulary
.operator
— required — (String
)The operator to use for the filter. Specify EQ when the
Possible values include:ListExports
operation should return only resource types that equal the specified value. Specify CO when theListExports
operation should return resource types that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListExports
operation contains more results that specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListExports
request to return the next page of results. For a complete set of results, call theListExports
operation until thenextToken
returned in the response is null.localeId
— (String
)Specifies the resources that should be exported. If you don't specify a resource type in the
filters
parameter, both bot locales and custom vocabularies are exported.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier assigned to the bot by Amazon Lex.
botVersion
— (String
)The version of the bot that was exported.
exportSummaries
— (Array<map>
)Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more exports available, thenextToken
field contains a token to get the next page of results.exportId
— (String
)The unique identifier that Amazon Lex assigned to the export.
resourceSpecification
— (map
)Information about the bot or bot locale that was exported.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format used in the export files.
Possible values include:"LexJson"
"TSV"
"CSV"
exportStatus
— (String
)The status of the export. When the status is
Possible values include:Completed
the export is ready to download."InProgress"
"Completed"
"Failed"
"Deleting"
creationDateTime
— (Date
)The date and time that the export was created.
lastUpdatedDateTime
— (Date
)The date and time that the export was last updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListExports
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListExports
operation request to get the next page of results.localeId
— (String
)The locale specified in the request.
-
(AWS.Response)
—
Returns:
listImports(params = {}, callback) ⇒ AWS.Request
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
Service Reference:
Examples:
Calling the listImports operation
var params = { botId: 'STRING_VALUE', botVersion: 'STRING_VALUE', filters: [ { name: ImportResourceType, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], localeId: 'STRING_VALUE', maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listImports(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier that Amazon Lex assigned to the bot.
botVersion
— (String
)The version of the bot to list imports for.
sortBy
— (map
)Determines the field that the list of imports is sorted by. You can sort by the
LastUpdatedDateTime
field in ascending or descending order.attribute
— required — (String
)The export field to use for sorting.
Possible values include:"LastUpdatedDateTime"
order
— required — (String
)The order to sort the list.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
name
— required — (String
)The name of the field to use for filtering.
Possible values include:"ImportResourceType"
values
— required — (Array<String>
)The values to use to filter the response. The values must be
Bot
,BotLocale
, orCustomVocabulary
.operator
— required — (String
)The operator to use for the filter. Specify EQ when the
Possible values include:ListImports
operation should return only resource types that equal the specified value. Specify CO when theListImports
operation should return resource types that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListImports
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListImports
request to return the next page of results. For a complete set of results, call theListImports
operation until thenextToken
returned in the response is null.localeId
— (String
)Specifies the locale that should be present in the list. If you don't specify a resource type in the
filters
parameter, the list contains both bot locales and custom vocabularies.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier assigned by Amazon Lex to the bot.
botVersion
— (String
)The version of the bot that was imported. It will always be
DRAFT
.importSummaries
— (Array<map>
)Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more imports available, thenextToken
field contains a token to get the next page of results.importId
— (String
)The unique identifier that Amazon Lex assigned to the import.
importedResourceId
— (String
)The unique identifier that Amazon Lex assigned to the imported resource.
importedResourceName
— (String
)The name that you gave the imported resource.
importStatus
— (String
)The status of the resource. When the status is
Possible values include:Completed
the resource is ready to build."InProgress"
"Completed"
"Failed"
"Deleting"
mergeStrategy
— (String
)The strategy used to merge existing bot or bot locale definitions with the imported definition.
Possible values include:"Overwrite"
"FailOnConflict"
"Append"
creationDateTime
— (Date
)The date and time that the import was created.
lastUpdatedDateTime
— (Date
)The date and time that the import was last updated.
importedResourceType
— (String
)The type of resource that was imported.
Possible values include:"Bot"
"BotLocale"
"CustomVocabulary"
"TestSet"
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListImports
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListImports
operation request to get the next page of results.localeId
— (String
)The locale specified in the request.
-
(AWS.Response)
—
Returns:
listIntentMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the intents in your bot. The following fields are required:
-
metrics
– A list of AnalyticsIntentMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an
order
field exists in bothbinBy
andmetrics
. You can specify only oneorder
in a given request.Service Reference:
Examples:
Calling the listIntentMetrics operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ metrics: [ /* required */ { name: Count | Success | Failure | Switched | Dropped, /* required */ statistic: Sum | Avg | Max, /* required */ order: Ascending | Descending }, /* more items */ ], startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ binBy: [ { interval: OneHour | OneDay, /* required */ name: ConversationStartTime | UtteranceTimestamp, /* required */ order: Ascending | Descending }, /* more items */ ], filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | IntentName | IntentEndState, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], groupBy: [ { name: IntentName | IntentEndState | IntentLevel /* required */ }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listIntentMetrics(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve intent metrics.
startDateTime
— (Date
)The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see intent metrics.
metrics
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
name
— required — (String
)The metric for which you want to get intent summary statistics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
"Count"
"Success"
"Failure"
"Switched"
"Dropped"
-
statistic
— required — (String
)The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
order
— (String
)Specifies whether to sort the results in ascending or descending order.
Possible values include:"Ascending"
"Descending"
binBy
— (Array<map>
)A list of objects, each of which contains specifications for organizing the results by time.
name
— required — (String
)Specifies the time metric by which to bin the analytics data.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
interval
— required — (String
)Specifies the interval of time by which to bin the analytics data.
Possible values include:"OneHour"
"OneDay"
order
— (String
)Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
Possible values include:"Ascending"
"Descending"
groupBy
— (Array<map>
)A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
IntentName
– The name of the intent. -
IntentEndState
– The final state of the intent. The possible end states are detailed in Key definitions in the user guide.
name
— required — (String
)Specifies whether to group the intent stages by their name or their end state.
Possible values include:"IntentName"
"IntentEndState"
"IntentLevel"
-
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the intents. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentName
– The name of the intent. -
IntentEndState
– The final state of the intent.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"SessionId"
"OriginatingRequestId"
"IntentName"
"IntentEndState"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentEndState
–EQ
,CO
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier for the bot for which you retrieved intent metrics.
results
— (Array<map>
)The results for the intent metrics.
binKeys
— (Array<map>
)A list of objects containing the criteria you requested for binning results and the values of the bins.
name
— (String
)The criterion by which to bin the results.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
value
— (Integer
)The value of the criterion that defines the bin.
groupByKeys
— (Array<map>
)A list of objects containing the criteria you requested for grouping results and the values of the groups.
name
— (String
)A category by which the intent analytics were grouped.
Possible values include:"IntentName"
"IntentEndState"
"IntentLevel"
value
— (String
)A member of the category by which the intent analytics were grouped.
metricsResults
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— (String
)The metric that you requested. See Key definitions for more details about these metrics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
"Count"
"Success"
"Failure"
"Switched"
"Dropped"
-
statistic
— (String
)The statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
value
— (Float
)The value of the summary statistic for the metric that you requested.
nextToken
— (String
)If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
-
(AWS.Response)
—
Returns:
listIntentPaths(params = {}, callback) ⇒ AWS.Request
Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:
-
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results. -
intentPath
– Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate theintentPath
field with/BookCar/BookHotel
to see details about how many times users invoked theBookCar
andBookHotel
intents in that order.
Use the optional
filters
field to filter the results.Service Reference:
Examples:
Calling the listIntentPaths operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ intentPath: 'STRING_VALUE', /* required */ startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ] }; lexmodelsv2.listIntentPaths(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve intent path metrics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see intent path metrics.
intentPath
— (String
)The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
-
/BookCar
-
/BookCar/BookHotel
-
/BookHotel/BookCar
-
filters
— (Array<map>
)A list of objects, each describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the intent paths. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nodeSummaries
— (Array<map>
)A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
intentName
— (String
)The name of the intent at the end of the requested path.
intentPath
— (String
)The path.
intentCount
— (Integer
)The total number of sessions that follow the given path to the given intent.
intentLevel
— (Integer
)The number of intents up to and including the requested path.
nodeType
— (String
)Specifies whether the node is the end of a path (
Possible values include:Exit
) or not (Inner
)."Inner"
"Exit"
-
(AWS.Response)
—
Returns:
listIntents(params = {}, callback) ⇒ AWS.Request
Get a list of intents that meet the specified criteria.
Service Reference:
Examples:
Calling the listIntents operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ filters: [ { name: IntentName, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: IntentName | LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listIntents(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the intent.
botVersion
— (String
)The version of the bot that contains the intent.
localeId
— (String
)The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
sortBy
— (map
)Determines the sort order for the response from the
ListIntents
operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.attribute
— required — (String
)The attribute to use to sort the list of intents.
Possible values include:"IntentName"
"LastUpdatedDateTime"
order
— required — (String
)The order to sort the list. You can choose ascending or descending.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
name
— required — (String
)The name of the field to use for the filter.
Possible values include:"IntentName"
values
— required — (Array<String>
)The value to use for the filter.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListIntents
operation should return only aliases that equal the specified value. SpecifyCO
when theListIntents
operation should return aliases that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListIntents
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListIntents
request to return the next page of results. For a complete set of results, call theListIntents
operation until thenextToken
returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the intent.
botVersion
— (String
)The version of the bot that contains the intent.
localeId
— (String
)The language and locale of the intents in the list.
intentSummaries
— (Array<map>
)Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more intents available, thenextToken
field contains a token to get the next page of results.intentId
— (String
)The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the
DescribeIntent
operation.intentName
— (String
)The name of the intent.
description
— (String
)The description of the intent.
parentIntentSignature
— (String
)If this intent is derived from a built-in intent, the name of the parent intent.
inputContexts
— (Array<map>
)The input contexts that must be active for this intent to be considered for recognition.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)The output contexts that are activated when this intent is fulfilled.
name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
lastUpdatedDateTime
— (Date
)The timestamp of the date and time that the intent was last updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListIntents
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListIntents
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listIntentStageMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the stages within intents in your bot. The following fields are required:
-
metrics
– A list of AnalyticsIntentStageMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an
order
field exists in bothbinBy
andmetrics
. You can only specify oneorder
in a given request.Service Reference:
Examples:
Calling the listIntentStageMetrics operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ metrics: [ /* required */ { name: Count | Success | Failed | Dropped | Retry, /* required */ statistic: Sum | Avg | Max, /* required */ order: Ascending | Descending }, /* more items */ ], startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ binBy: [ { interval: OneHour | OneDay, /* required */ name: ConversationStartTime | UtteranceTimestamp, /* required */ order: Ascending | Descending }, /* more items */ ], filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | IntentName | IntentStageName, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], groupBy: [ { name: IntentStageName | SwitchedToIntent /* required */ }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listIntentStageMetrics(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve intent stage metrics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see intent stage metrics.
metrics
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— required — (String
)The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
-
Count
– The number of times the intent stage occurred. -
Success
– The number of times the intent stage succeeded. -
Failure
– The number of times the intent stage failed. -
Dropped
– The number of times the user dropped the intent stage. -
Retry
– The number of times the bot tried to elicit a response from the user at this stage.
"Count"
"Success"
"Failed"
"Dropped"
"Retry"
-
statistic
— required — (String
)The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intent stages in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
order
— (String
)Specifies whether to sort the results in ascending or descending order of the summary statistic (
Possible values include:value
in the response)."Ascending"
"Descending"
binBy
— (Array<map>
)A list of objects, each of which contains specifications for organizing the results by time.
name
— required — (String
)Specifies the time metric by which to bin the analytics data.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
interval
— required — (String
)Specifies the interval of time by which to bin the analytics data.
Possible values include:"OneHour"
"OneDay"
order
— (String
)Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
Possible values include:"Ascending"
"Descending"
groupBy
— (Array<map>
)A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
IntentStageName
– The name of the intent stage. -
SwitchedToIntent
– The intent to which the conversation was switched (if any).
name
— required — (String
)Specifies whether to group the intent stages by their name or the intent to which the session was switched.
Possible values include:"IntentStageName"
"SwitchedToIntent"
-
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the intent stages. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentName
– The name of the intent. -
IntentStageName
– The stage in the intent.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"SessionId"
"OriginatingRequestId"
"IntentName"
"IntentStageName"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentStageName
–EQ
,CO
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier for the bot for which you retrieved intent stage metrics.
results
— (Array<map>
)The results for the intent stage metrics.
binKeys
— (Array<map>
)A list of objects containing the criteria you requested for binning results and the values of the bins.
name
— (String
)The criterion by which to bin the results.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
value
— (Integer
)The value of the criterion that defines the bin.
groupByKeys
— (Array<map>
)A list of objects containing the criteria you requested for grouping results and the values of the bins.
name
— (String
)A category by which the intent stage analytics were grouped.
Possible values include:"IntentStageName"
"SwitchedToIntent"
value
— (String
)A member of the category by which the intent stage analytics were grouped.
metricsResults
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— (String
)The metric that you requested.
-
Count
– The number of times the intent stage occurred. -
Success
– The number of times the intent stage succeeded. -
Failure
– The number of times the intent stage failed. -
Dropped
– The number of times the user dropped the intent stage. -
Retry
– The number of times the bot tried to elicit a response from the user at this stage.
"Count"
"Success"
"Failed"
"Dropped"
"Retry"
-
statistic
— (String
)The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intent stages in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
value
— (Float
)The value of the summary statistic for the metric that you requested.
nextToken
— (String
)If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
-
(AWS.Response)
—
Returns:
listRecommendedIntents(params = {}, callback) ⇒ AWS.Request
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
Service Reference:
Examples:
Calling the listRecommendedIntents operation
var params = { botId: 'STRING_VALUE', /* required */ botRecommendationId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listRecommendedIntents(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot associated with the recommended intents.
botVersion
— (String
)The version of the bot that contains the recommended intents.
localeId
— (String
)The identifier of the language and locale of the recommended intents.
botRecommendationId
— (String
)The identifier of the bot recommendation that contains the recommended intents.
nextToken
— (String
)If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
maxResults
— (Integer
)The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot associated with the recommended intent.
botVersion
— (String
)The version of the bot that contains the intent.
localeId
— (String
)The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
botRecommendationId
— (String
)The identifier of the bot recommendation that contains the recommended intent.
summaryList
— (Array<map>
)Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
intentId
— (String
)The unique identifier of a recommended intent associated with the bot recommendation.
intentName
— (String
)The name of a recommended intent associated with the bot recommendation.
sampleUtterancesCount
— (Integer
)The count of sample utterances of a recommended intent that is associated with a bot recommendation.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listSessionAnalyticsData(params = {}, callback) ⇒ AWS.Request
Retrieves a list of metadata for individual user sessions with your bot. The
startDateTime
andendDateTime
fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:-
Use the
filters
field to filter the results and thesortBy
field to specify the values by which to sort the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Service Reference:
Examples:
Calling the listSessionAnalyticsData operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | Duration | ConversationEndState | SessionId | OriginatingRequestId | IntentPath, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { name: ConversationStartTime | NumberOfTurns | Duration, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listSessionAnalyticsData(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve session analytics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see session analytics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see session analytics.
sortBy
— (map
)An object specifying the measure and method by which to sort the session analytics data.
name
— required — (String
)The measure by which to sort the session analytics data.
-
conversationStartTime
– The date and time when the conversation began. A conversation is defined as a unique combination of asessionId
and anoriginatingRequestId
. -
numberOfTurns
– The number of turns that the session took. -
conversationDurationSeconds
– The duration of the conversation in seconds.
"ConversationStartTime"
"NumberOfTurns"
"Duration"
-
order
— required — (String
)Specifies whether to sort the results in ascending or descending order.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"Duration"
"ConversationEndState"
"SessionId"
"OriginatingRequestId"
"IntentPath"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot that the sessions belong to.
nextToken
— (String
)If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
sessions
— (Array<map>
)A list of objects, each of which contains information about a session with the bot.
botAliasId
— (String
)The identifier of the alias of the bot that the session was held with.
botVersion
— (String
)The version of the bot that the session was held with.
localeId
— (String
)The locale of the bot that the session was held with.
channel
— (String
)The channel that is integrated with the bot that the session was held with.
sessionId
— (String
)The identifier of the session.
conversationStartTime
— (Date
)The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
.conversationEndTime
— (Date
)The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
.conversationDurationSeconds
— (Integer
)The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
.conversationEndState
— (String
)The final state of the conversation. A conversation is defined as a unique combination of a
Possible values include:sessionId
and anoriginatingRequestId
."Success"
"Failure"
"Dropped"
mode
— (String
)The mode of the session. The possible values are as follows:
-
Speech
– The session was spoken. -
Text
– The session was written. -
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency). -
MultiMode
– The session used multiple modes.
"Speech"
"Text"
"DTMF"
"MultiMode"
-
numberOfTurns
— (Integer
)The number of turns that the session took.
invokedIntentSamples
— (Array<map>
)A list of objects containing the name of an intent that was invoked.
intentName
— (String
)The name of an intent that was invoked.
originatingRequestId
— (String
)The identifier of the first request in a session.
-
(AWS.Response)
—
Returns:
listSessionMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves summary metrics for the user sessions with your bot. The following fields are required:
-
metrics
– A list of AnalyticsSessionMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an
order
field exists in bothbinBy
andmetrics
. Currently, you can specify it in either field, but not in both.Service Reference:
Examples:
Calling the listSessionMetrics operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ metrics: [ /* required */ { name: Count | Success | Failure | Dropped | Duration | TurnsPerConversation | Concurrency, /* required */ statistic: Sum | Avg | Max, /* required */ order: Ascending | Descending }, /* more items */ ], startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ binBy: [ { interval: OneHour | OneDay, /* required */ name: ConversationStartTime | UtteranceTimestamp, /* required */ order: Ascending | Descending }, /* more items */ ], filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | Duration | ConversationEndState | SessionId | OriginatingRequestId | IntentPath, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], groupBy: [ { name: ConversationEndState | LocaleId /* required */ }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listSessionMetrics(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve session metrics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see session metrics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see session metrics.
metrics
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— required — (String
)The metric for which you want to get session summary statistics.
-
Count
– The number of sessions. -
Success
– The number of sessions that succeeded. -
Failure
– The number of sessions that failed. -
Dropped
– The number of sessions that the user dropped. -
Duration
– The duration of sessions. -
TurnsPerSession
– The number of turns in the sessions. -
Concurrency
– The number of sessions occurring in the same period of time.
"Count"
"Success"
"Failure"
"Dropped"
"Duration"
"TurnsPerConversation"
"Concurrency"
-
statistic
— required — (String
)The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of sessions in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
order
— (String
)Specifies whether to sort the results in ascending or descending order.
Possible values include:"Ascending"
"Descending"
binBy
— (Array<map>
)A list of objects, each of which contains specifications for organizing the results by time.
name
— required — (String
)Specifies the time metric by which to bin the analytics data.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
interval
— required — (String
)Specifies the interval of time by which to bin the analytics data.
Possible values include:"OneHour"
"OneDay"
order
— (String
)Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
Possible values include:"Ascending"
"Descending"
groupBy
— (Array<map>
)A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
ConversationEndState
– The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. -
LocaleId
– The unique identifier of the bot locale.
name
— required — (String
)Specifies whether to group the session by their end state or their locale.
Possible values include:"ConversationEndState"
"LocaleId"
-
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"Duration"
"ConversationEndState"
"SessionId"
"OriginatingRequestId"
"IntentPath"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier for the bot for which you retrieved session metrics.
results
— (Array<map>
)The results for the session metrics.
binKeys
— (Array<map>
)A list of objects containing the criteria you requested for binning results and the values of the bins.
name
— (String
)The criterion by which to bin the results.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
value
— (Integer
)The value of the criterion that defines the bin.
groupByKeys
— (Array<map>
)A list of objects containing the criteria you requested for grouping results and the values of the bins.
name
— (String
)The category by which the session analytics were grouped.
Possible values include:"ConversationEndState"
"LocaleId"
value
— (String
)A member of the category by which the session analytics were grouped.
metricsResults
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— (String
)The metric that you requested.
-
Count
– The number of sessions. -
Success
– The number of sessions that succeeded. -
Failure
– The number of sessions that failed. -
Dropped
– The number of sessions that the user dropped. -
Duration
– The duration of sessions. -
TurnPersession
– The number of turns in the sessions. -
Concurrency
– The number of sessions occurring in the same period of time.
"Count"
"Success"
"Failure"
"Dropped"
"Duration"
"TurnsPerConversation"
"Concurrency"
-
statistic
— (String
)The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of sessions in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
value
— (Float
)The value of the summary statistic for the metric that you requested.
nextToken
— (String
)If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
-
(AWS.Response)
—
Returns:
listSlots(params = {}, callback) ⇒ AWS.Request
Gets a list of slots that match the specified criteria.
Service Reference:
Examples:
Calling the listSlots operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ filters: [ { name: SlotName, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: SlotName | LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listSlots(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier of the bot that contains the slot.
botVersion
— (String
)The version of the bot that contains the slot.
localeId
— (String
)The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.
intentId
— (String
)The unique identifier of the intent that contains the slot.
sortBy
— (map
)Determines the sort order for the response from the
ListSlots
operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.attribute
— required — (String
)The attribute to use to sort the list.
Possible values include:"SlotName"
"LastUpdatedDateTime"
order
— required — (String
)The order to sort the list. You can choose ascending or descending.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
name
— required — (String
)The name of the field to use for filtering.
Possible values include:"SlotName"
values
— required — (Array<String>
)The value to use to filter the response.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListSlots
operation should return only aliases that equal the specified value. SpecifyCO
when theListSlots
operation should return aliases that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListSlots
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the slots.
botVersion
— (String
)The version of the bot that contains the slots.
localeId
— (String
)The language and locale of the slots in the list.
intentId
— (String
)The identifier of the intent that contains the slots.
slotSummaries
— (Array<map>
)Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slots available, thenextToken
field contains a token to get the next page of results.slotId
— (String
)The unique identifier of the slot.
slotName
— (String
)The name given to the slot.
description
— (String
)The description of the slot.
slotConstraint
— (String
)Whether the slot is required or optional. An intent is complete when all required slots are filled.
Possible values include:"Required"
"Optional"
slotTypeId
— (String
)The unique identifier for the slot type that defines the values for the slot.
valueElicitationPromptSpecification
— (map
)Prompts that are sent to the user to elicit a value for the slot.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
lastUpdatedDateTime
— (Date
)The timestamp of the last date and time that the slot was updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListSlots
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListSlots
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listSlotTypes(params = {}, callback) ⇒ AWS.Request
Gets a list of slot types that match the specified criteria.
Service Reference:
Examples:
Calling the listSlotTypes operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ filters: [ { name: SlotTypeName | ExternalSourceType, /* required */ operator: CO | EQ, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: SlotTypeName | LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listSlotTypes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the slot types.
botVersion
— (String
)The version of the bot that contains the slot type.
localeId
— (String
)The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
sortBy
— (map
)Determines the sort order for the response from the
ListSlotTypes
operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.attribute
— required — (String
)The attribute to use to sort the list of slot types.
Possible values include:"SlotTypeName"
"LastUpdatedDateTime"
order
— required — (String
)The order to sort the list. You can say ascending or descending.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
name
— required — (String
)The name of the field to use for filtering.
Possible values include:"SlotTypeName"
"ExternalSourceType"
values
— required — (Array<String>
)The value to use to filter the response.
operator
— required — (String
)The operator to use for the filter. Specify
Possible values include:EQ
when theListSlotTypes
operation should return only aliases that equal the specified value. SpecifyCO
when theListSlotTypes
operation should return aliases that contain the specified value."CO"
"EQ"
maxResults
— (Integer
)The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListSlotTypes
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the slot types.
botVersion
— (String
)The version of the bot that contains the slot types.
localeId
— (String
)The language and local of the slot types in the list.
slotTypeSummaries
— (Array<map>
)Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slot types available, thenextToken
field contains a token to get the next page of results.slotTypeId
— (String
)The unique identifier assigned to the slot type.
slotTypeName
— (String
)The name of the slot type.
description
— (String
)The description of the slot type.
parentSlotTypeSignature
— (String
)If the slot type is derived from a built-on slot type, the name of the parent slot type.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the slot type was last updated.
slotTypeCategory
— (String
)Indicates the type of the slot type.
-
Custom
- A slot type that you created using custom values. For more information, see Creating custom slot types. -
Extended
- A slot type created by extending theAMAZON.AlphaNumeric
built-in slot type. For more information, seeAMAZON.AlphaNumeric
. -
ExternalGrammar
- A slot type using a custom GRXML grammar to define values. For more information, see Using a custom grammar slot type.
"Custom"
"Extended"
"ExternalGrammar"
"Composite"
-
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListSlotTypes
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListSlotTypes
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = { resourceARN: 'STRING_VALUE' /* required */ }; lexmodelsv2.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the resource to get a list of tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:tags
— (map<String>
)The tags associated with a resource.
-
(AWS.Response)
—
Returns:
listTestExecutionResultItems(params = {}, callback) ⇒ AWS.Request
Gets a list of test execution result items.
Service Reference:
Examples:
Calling the listTestExecutionResultItems operation
var params = { resultFilterBy: { /* required */ resultTypeFilter: OverallTestResults | ConversationLevelTestResults | IntentClassificationTestResults | SlotResolutionTestResults | UtteranceLevelResults, /* required */ conversationLevelTestResultsFilterBy: { endToEndResult: Matched | Mismatched | ExecutionError } }, testExecutionId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listTestExecutionResultItems(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testExecutionId
— (String
)The unique identifier of the test execution to list the result items.
resultFilterBy
— (map
)The filter for the list of results from the test set execution.
resultTypeFilter
— required — (String
)Specifies which results to filter. See Test result details">Test results details for details about different types of results.
Possible values include:"OverallTestResults"
"ConversationLevelTestResults"
"IntentClassificationTestResults"
"SlotResolutionTestResults"
"UtteranceLevelResults"
conversationLevelTestResultsFilterBy
— (map
)Contains information about the method for filtering Conversation level test results.
endToEndResult
— (String
)The selection of matched or mismatched end-to-end status to filter test set results data at the conversation level.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
maxResults
— (Integer
)The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the
ListTestExecutionResultItems
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testExecutionResults
— (map
)The list of results from the test execution.
overallTestResults
— (map
)Overall results for the test execution, including the breakdown of conversations and single-input utterances.
items
— required — (Array<map>
)A list of the overall test results.
multiTurnConversation
— required — (Boolean
)Indicates whether the conversation contains multiple turns or not.
totalResultCount
— required — (Integer
)The total number of overall results in the result of the test execution.
speechTranscriptionResultCounts
— (map<Integer>
)The number of speech transcription results in the overall test.
endToEndResultCounts
— required — (map<Integer>
)The number of results that succeeded.
conversationLevelTestResults
— (map
)Results related to conversations in the test set, including metrics about success and failure of conversations and intent and slot failures.
items
— required — (Array<map>
)The item list in the test set results data at the conversation level.
conversationId
— required — (String
)The conversation Id of the test result evaluation item.
endToEndResult
— required — (String
)The end-to-end success or failure of the test result evaluation item.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
speechTranscriptionResult
— (String
)The speech transcription success or failure of the test result evaluation item.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
intentClassificationResults
— required — (Array<map>
)The intent classification of the test result evaluation item.
intentName
— required — (String
)The intent name used in the evaluation of intent level success or failure.
matchResult
— required — (String
)The number of times the specific intent is used in the evaluation of intent level success or failure.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
slotResolutionResults
— required — (Array<map>
)The slot success or failure of the test result evaluation item.
intentName
— required — (String
)The intents used in the slots list for the slot resolution details.
slotName
— required — (String
)The slot name in the slots list for the slot resolution details.
matchResult
— required — (String
)The number of matching slots used in the slots listings for the slot resolution evaluation.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
intentClassificationTestResults
— (map
)Intent recognition results aggregated by intent name. The aggregated results contain success and failure rates of intent recognition, speech transcriptions, and end-to-end conversations.
items
— required — (Array<map>
)A list of the results for the intent classification test.
intentName
— required — (String
)The name of the intent.
multiTurnConversation
— required — (Boolean
)Indicates whether the conversation involves multiple turns or not.
resultCounts
— required — (map
)The result of the intent classification test.
totalResultCount
— required — (Integer
)The total number of results in the intent classification test.
speechTranscriptionResultCounts
— (map<Integer>
)The number of matched, mismatched, and execution error results for speech transcription for the intent.
intentMatchResultCounts
— required — (map<Integer>
)The number of matched and mismatched results for intent recognition for the intent.
intentLevelSlotResolutionTestResults
— (map
)Slot resolution results aggregated by intent and slot name. The aggregated results contain success and failure rates of slot resolution, speech transcriptions, and end-to-end conversations
items
— required — (Array<map>
)Indicates the items for the slot level resolution for the intents.
intentName
— required — (String
)The name of the intent that was recognized.
multiTurnConversation
— required — (Boolean
)Indicates whether the conversation involves multiple turns or not.
slotResolutionResults
— required — (Array<map>
)The results for the slot resolution in the test execution result.
slotName
— required — (String
)The name of the slot.
resultCounts
— required — (map
)A result for slot resolution in the results of a test execution.
totalResultCount
— required — (Integer
)The total number of results.
speechTranscriptionResultCounts
— (map<Integer>
)The number of matched, mismatched and execution error results for speech transcription for the slot.
slotMatchResultCounts
— required — (map<Integer>
)The number of matched and mismatched results for slot resolution for the slot.
utteranceLevelTestResults
— (map
)Results related to utterances in the test set.
items
— required — (Array<map>
)Contains information about an utterance in the results of the test set execution.
recordNumber
— required — (Integer
)The record number of the result.
conversationId
— (String
)The unique identifier for the conversation associated with the result.
turnResult
— required — (map
)Contains information about the turn associated with the result.
agent
— (map
)Contains information about the agent messages in the turn.
expectedAgentPrompt
— required — (String
)The expected agent prompt for the agent turn in a test set execution.
actualAgentPrompt
— (String
)The actual agent prompt for the agent turn in a test set execution.
errorDetails
— (map
)Details about an error in an execution of a test set.
errorCode
— required — (String
)The error code for the error.
errorMessage
— required — (String
)The message describing the error.
actualElicitedSlot
— (String
)The actual elicited slot for the agent turn in a test set execution.
actualIntent
— (String
)The actual intent for the agent turn in a test set execution.
user
— (map
)Contains information about the user messages in the turn.
input
— required — (map
)Contains information about the user messages in the turn in the input.
utteranceInput
— required — (map
)The utterance input in the user turn.
textInput
— (String
)A text input transcription of the utterance. It is only applicable for test-sets containing text data.
audioInput
— (map
)Contains information about the audio input for an utterance.
audioFileS3Location
— required — (String
)Amazon S3 file pointing to the audio.
requestAttributes
— (map<String>
)Request attributes of the user turn.
sessionState
— (map
)Contains information about the session state in the input.
sessionAttributes
— (map<String>
)Session attributes for the session state.
activeContexts
— (Array<map>
)Active contexts for the session state.
name
— required — (String
)The name of active context.
runtimeHints
— (map
)Runtime hints for the session state.
slotHints
— (map<map<map>>
)A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the
slotHints
map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.The intent name and slot name must exist.
runtimeHintValues
— (Array<map>
)One or more strings that Amazon Lex should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
phrase
— required — (String
)The phrase that Amazon Lex should look for in the user's input to the bot.
expectedOutput
— required — (map
)Contains information about the expected output for the user turn.
intent
— required — (map
)Contains information about the intent.
name
— required — (String
)The name of the intent.
slots
— (map<map>
)The slots associated with the intent.
value
— (String
)The value output by the slot recognition.
values
— (Array<map>
)Values that are output by the slot recognition.
activeContexts
— (Array<map>
)The contexts that are active in the turn.
name
— required — (String
)The name of active context.
transcript
— (String
)The transcript that is output for the user turn by the test execution.
actualOutput
— (map
)Contains information about the actual output for the user turn.
intent
— required — (map
)Contains information about the intent.
name
— required — (String
)The name of the intent.
slots
— (map<map>
)The slots associated with the intent.
value
— (String
)The value output by the slot recognition.
values
— (Array<map>
)Values that are output by the slot recognition.
activeContexts
— (Array<map>
)The contexts that are active in the turn.
name
— required — (String
)The name of active context.
transcript
— (String
)The transcript that is output for the user turn by the test execution.
errorDetails
— (map
)Details about an error in an execution of a test set.
errorCode
— required — (String
)The error code for the error.
errorMessage
— required — (String
)The message describing the error.
endToEndResult
— (String
)Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
intentMatchResult
— (String
)Specifies whether the expected and actual intents match or not.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
slotMatchResult
— (String
)Specifies whether the expected and actual slots match or not.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
speechTranscriptionResult
— (String
)Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
conversationLevelResult
— (map
)Contains information about the results related to the conversation associated with the user turn.
endToEndResult
— required — (String
)The success or failure of the streaming of the conversation.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
speechTranscriptionResult
— (String
)The speech transcription success or failure details of the conversation.
Possible values include:"Matched"
"Mismatched"
"ExecutionError"
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the
ListTestExecutionResultItems
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListTestExecutionResultItems
operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listTestExecutions(params = {}, callback) ⇒ AWS.Request
The list of test set executions.
Service Reference:
Examples:
Calling the listTestExecutions operation
var params = { maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: TestSetName | CreationDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listTestExecutions(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
sortBy
— (map
)The sort order of the test set executions.
attribute
— required — (String
)Specifies whether to sort the test set executions by the date and time at which the test sets were created.
Possible values include:"TestSetName"
"CreationDateTime"
order
— required — (String
)Specifies whether to sort in ascending or descending order.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testExecutions
— (Array<map>
)The list of test executions.
testExecutionId
— (String
)The unique identifier of the test execution.
creationDateTime
— (Date
)The date and time at which the test execution was created.
lastUpdatedDateTime
— (Date
)The date and time at which the test execution was last updated.
testExecutionStatus
— (String
)The current status of the test execution.
Possible values include:"Pending"
"Waiting"
"InProgress"
"Completed"
"Failed"
"Stopping"
"Stopped"
testSetId
— (String
)The unique identifier of the test set used in the test execution.
testSetName
— (String
)The name of the test set used in the test execution.
target
— (map
)Contains information about the bot used for the test execution..
botAliasTarget
— (map
)Contains information about the bot alias used for the test execution.
botId
— required — (String
)The bot Id of the bot alias used in the test set execution.
botAliasId
— required — (String
)The bot alias Id of the bot alias used in the test set execution.
localeId
— required — (String
)The locale Id of the bot alias used in the test set execution.
apiMode
— (String
)Specifies whether the API mode for the test execution is streaming or non-streaming.
Possible values include:"Streaming"
"NonStreaming"
testExecutionModality
— (String
)Specifies whether the data used for the test execution is written or spoken.
Possible values include:"Text"
"Audio"
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listTestSetRecords(params = {}, callback) ⇒ AWS.Request
The list of test set records.
Service Reference:
Examples:
Calling the listTestSetRecords operation
var params = { testSetId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listTestSetRecords(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The identifier of the test set to list its test set records.
maxResults
— (Integer
)The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.
nextToken
— (String
)If the response from the ListTestSetRecords operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetRecords
— (Array<map>
)The list of records from the test set.
recordNumber
— required — (Integer
)The record number associated with the turn.
conversationId
— (String
)The unique identifier for the conversation associated with the turn.
turnNumber
— (Integer
)The number of turns that has elapsed up to that turn.
turnSpecification
— required — (map
)Contains information about the agent or user turn depending upon type of turn.
agentTurn
— (map
)Contains information about the agent messages in the turn.
agentPrompt
— required — (String
)The agent prompt for the agent turn in a test set.
userTurn
— (map
)Contains information about the user messages in the turn.
input
— required — (map
)Contains information about the user messages in the turn in the input.
utteranceInput
— required — (map
)The utterance input in the user turn.
textInput
— (String
)A text input transcription of the utterance. It is only applicable for test-sets containing text data.
audioInput
— (map
)Contains information about the audio input for an utterance.
audioFileS3Location
— required — (String
)Amazon S3 file pointing to the audio.
requestAttributes
— (map<String>
)Request attributes of the user turn.
sessionState
— (map
)Contains information about the session state in the input.
sessionAttributes
— (map<String>
)Session attributes for the session state.
activeContexts
— (Array<map>
)Active contexts for the session state.
name
— required — (String
)The name of active context.
runtimeHints
— (map
)Runtime hints for the session state.
slotHints
— (map<map<map>>
)A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the
slotHints
map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.The intent name and slot name must exist.
runtimeHintValues
— (Array<map>
)One or more strings that Amazon Lex should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
phrase
— required — (String
)The phrase that Amazon Lex should look for in the user's input to the bot.
expected
— required — (map
)Contains results about the expected output for the user turn.
intent
— required — (map
)Contains information about the intent.
name
— required — (String
)The name of the intent.
slots
— (map<map>
)The slots associated with the intent.
value
— (String
)The value output by the slot recognition.
values
— (Array<map>
)Values that are output by the slot recognition.
activeContexts
— (Array<map>
)The contexts that are active in the turn.
name
— required — (String
)The name of active context.
transcript
— (String
)The transcript that is output for the user turn by the test execution.
nextToken
— (String
)A token that indicates whether there are more records to return in a response to the ListTestSetRecords operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSetRecords operation request to get the next page of records.
-
(AWS.Response)
—
Returns:
listTestSets(params = {}, callback) ⇒ AWS.Request
The list of the test sets
Service Reference:
Examples:
Calling the listTestSets operation
var params = { maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { attribute: TestSetName | LastUpdatedDateTime, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listTestSets(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
sortBy
— (map
)The sort order for the list of test sets.
attribute
— required — (String
)Specifies whether to sort the test sets by name or by the time they were last updated.
Possible values include:"TestSetName"
"LastUpdatedDateTime"
order
— required — (String
)Specifies whether to sort in ascending or descending order.
Possible values include:"Ascending"
"Descending"
maxResults
— (Integer
)The maximum number of test sets to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListTestSets operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSets
— (Array<map>
)The selected test sets in a list of test sets.
testSetId
— (String
)The unique identifier of the test set.
testSetName
— (String
)The name of the test set.
description
— (String
)The description of the test set.
modality
— (String
)Specifies whether the test set contains written or spoken data.
Possible values include:"Text"
"Audio"
status
— (String
)The status of the test set.
Possible values include:"Importing"
"PendingAnnotation"
"Deleting"
"ValidationError"
"Ready"
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
numTurns
— (Integer
)The number of turns in the test set.
storageLocation
— (map
)Contains information about the location at which the test set is stored.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
creationDateTime
— (Date
)The date and time at which the test set was created.
lastUpdatedDateTime
— (Date
)The date and time at which the test set was last updated.
nextToken
— (String
)A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.
-
(AWS.Response)
—
Returns:
listUtteranceAnalyticsData(params = {}, callback) ⇒ AWS.Request
Note: To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:
-
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results and thesortBy
field to specify the values by which to sort the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Service Reference:
Examples:
Calling the listUtteranceAnalyticsData operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | UtteranceState | UtteranceText, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', sortBy: { name: UtteranceTimestamp, /* required */ order: Ascending | Descending /* required */ } }; lexmodelsv2.listUtteranceAnalyticsData(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve utterance analytics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see utterance analytics.
sortBy
— (map
)An object specifying the measure and method by which to sort the utterance analytics data.
name
— required — (String
)The measure by which to sort the utterance analytics data.
-
Count
– The number of utterances. -
UtteranceTimestamp
– The date and time of the utterance.
"UtteranceTimestamp"
-
order
— required — (String
)Specifies whether to sort the results in ascending or descending order.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the utterances. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
UtteranceState
– The state of the utterance. -
UtteranceText
– The text in the utterance.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"SessionId"
"OriginatingRequestId"
"UtteranceState"
"UtteranceText"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
UtteranceState
–EQ
. -
UtteranceText
–EQ
,CO
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot that the utterances belong to.
nextToken
— (String
)If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
utterances
— (Array<map>
)A list of objects, each of which contains information about an utterance in a user session with your bot.
botAliasId
— (String
)The identifier of the alias of the bot that the utterance was made to.
botVersion
— (String
)The version of the bot that the utterance was made to.
localeId
— (String
)The locale of the bot that the utterance was made to.
sessionId
— (String
)The identifier of the session that the utterance was made in.
channel
— (String
)The channel that is integrated with the bot that the utterance was made to.
mode
— (String
)The mode of the session. The possible values are as follows:
-
Speech
– The session consisted of spoken dialogue. -
Text
– The session consisted of written dialogue. -
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses. -
MultiMode
– The session consisted of multiple modes.
"Speech"
"Text"
"DTMF"
"MultiMode"
-
conversationStartTime
— (Date
)The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
.conversationEndTime
— (Date
)The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
.utterance
— (String
)The text of the utterance.
utteranceTimestamp
— (Date
)The date and time when the utterance took place.
audioVoiceDurationMillis
— (Integer
)The duration in milliseconds of the audio associated with the utterance.
utteranceUnderstood
— (Boolean
)Specifies whether the bot understood the utterance or not.
inputType
— (String
)The input type of the utterance. The possible values are as follows:
-
PCM format: audio data must be in little-endian byte order.
-
audio/l16; rate=16000; channels=1
-
audio/x-l16; sample-rate=16000; channel-count=1
-
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
-
-
Opus format
-
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
-
-
Text format
-
text/plain; charset=utf-8
-
-
outputType
— (String
)The output type of the utterance. The possible values are as follows:
-
audio/mpeg
-
audio/ogg
-
audio/pcm (16 KHz)
-
audio/
(defaults tompeg
) -
text/plain; charset=utf-8
-
associatedIntentName
— (String
)The name of the intent that the utterance is associated to.
associatedSlotName
— (String
)The name of the slot that the utterance is associated to.
intentState
— (String
)The state of the intent that the utterance is associated to.
Possible values include:"Failed"
"Fulfilled"
"InProgress"
"ReadyForFulfillment"
"Waiting"
"FulfillmentInProgress"
dialogActionType
— (String
)The type of dialog action that the utterance is associated to. See the
type
field in DialogAction for more information.botResponseAudioVoiceId
— (String
)The identifier for the audio of the bot response.
slotsFilledInSession
— (String
)The slots that have been filled in the session by the time of the utterance.
utteranceRequestId
— (String
)The identifier of the request associated with the utterance.
botResponses
— (Array<map>
)A list of objects containing information about the bot response to the utterance.
content
— (String
)The text of the response to the utterance from the bot.
contentType
— (String
)The type of the response. The following values are possible:
-
PlainText
– A plain text string. -
CustomPayload
– A response string that you can customize to include data or metadata for your application. -
SSML
– A string that includes Speech Synthesis Markup Language to customize the audio response. -
ImageResponseCard
– An image with buttons that the customer can select. See ImageResponseCard for more information.
"PlainText"
"CustomPayload"
"SSML"
"ImageResponseCard"
-
imageResponseCard
— (map
)A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
-
(AWS.Response)
—
Returns:
listUtteranceMetrics(params = {}, callback) ⇒ AWS.Request
Note: To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.Retrieves summary metrics for the utterances in your bot. The following fields are required:
-
metrics
– A list of AnalyticsUtteranceMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an
order
field exists in bothbinBy
andmetrics
. Currently, you can specify it in either field, but not in both.Service Reference:
Examples:
Calling the listUtteranceMetrics operation
var params = { botId: 'STRING_VALUE', /* required */ endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ metrics: [ /* required */ { name: Count | Missed | Detected | UtteranceTimestamp, /* required */ statistic: Sum | Avg | Max, /* required */ order: Ascending | Descending }, /* more items */ ], startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ attributes: [ { name: LastUsedIntent /* required */ }, /* more items */ ], binBy: [ { interval: OneHour | OneDay, /* required */ name: ConversationStartTime | UtteranceTimestamp, /* required */ order: Ascending | Descending }, /* more items */ ], filters: [ { name: BotAliasId | BotVersion | LocaleId | Modality | Channel | SessionId | OriginatingRequestId | UtteranceState | UtteranceText, /* required */ operator: EQ | GT | LT, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], groupBy: [ { name: UtteranceText | UtteranceState /* required */ }, /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; lexmodelsv2.listUtteranceMetrics(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The identifier for the bot for which you want to retrieve utterance metrics.
startDateTime
— (Date
)The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
endDateTime
— (Date
)The date and time that marks the end of the range of time for which you want to see utterance metrics.
metrics
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— required — (String
)The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
"Count"
"Missed"
"Detected"
"UtteranceTimestamp"
-
statistic
— required — (String
)The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
order
— (String
)Specifies whether to sort the results in ascending or descending order.
Possible values include:"Ascending"
"Descending"
binBy
— (Array<map>
)A list of objects, each of which contains specifications for organizing the results by time.
name
— required — (String
)Specifies the time metric by which to bin the analytics data.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
interval
— required — (String
)Specifies the interval of time by which to bin the analytics data.
Possible values include:"OneHour"
"OneDay"
order
— (String
)Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
Possible values include:"Ascending"
"Descending"
groupBy
— (Array<map>
)A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
UtteranceText
– The transcription of the utterance. -
UtteranceState
– The state of the utterance. The possible states are detailed in Key definitions in the user guide.
name
— required — (String
)Specifies whether to group the utterances by their text or their state.
Possible values include:"UtteranceText"
"UtteranceState"
-
attributes
— (Array<map>
)A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
-
LastUsedIntent
– The last used intent at the time of the utterance.
name
— required — (String
)An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
Possible values include:"LastUsedIntent"
-
filters
— (Array<map>
)A list of objects, each of which describes a condition by which you want to filter the results.
name
— required — (String
)The category by which to filter the utterances. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
UtteranceState
– The state of the utterance. -
UtteranceText
– The text in the utterance.
"BotAliasId"
"BotVersion"
"LocaleId"
"Modality"
"Channel"
"SessionId"
"OriginatingRequestId"
"UtteranceState"
"UtteranceText"
-
operator
— required — (String
)The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
UtteranceState
–EQ
. -
UtteranceText
–EQ
,CO
.
"EQ"
"GT"
"LT"
-
values
— required — (Array<String>
)An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
maxResults
— (Integer
)The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
nextToken
— (String
)If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier for the bot for which you retrieved utterance metrics.
results
— (Array<map>
)The results for the utterance metrics.
binKeys
— (Array<map>
)A list of objects containing the criteria you requested for binning results and the values of the bins.
name
— (String
)The criterion by which to bin the results.
Possible values include:"ConversationStartTime"
"UtteranceTimestamp"
value
— (Integer
)The value of the criterion that defines the bin.
groupByKeys
— (Array<map>
)A list of objects containing the criteria you requested for grouping results and the values of the bins.
name
— (String
)The category by which the utterance analytics were grouped.
Possible values include:"UtteranceText"
"UtteranceState"
value
— (String
)A member of the category by which the utterance analytics were grouped.
metricsResults
— (Array<map>
)A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
name
— (String
)The metric that you requested.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
"Count"
"Missed"
"Detected"
"UtteranceTimestamp"
-
statistic
— (String
)The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
"Sum"
"Avg"
"Max"
-
value
— (Float
)The value of the summary statistic for the metric that you requested.
attributeResults
— (Array<map>
)A list of objects containing information about the last used intent at the time of an utterance.
lastUsedIntent
— (String
)The intent that the bot mapped the utterance to.
nextToken
— (String
)If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
-
(AWS.Response)
—
Returns:
searchAssociatedTranscripts(params = {}, callback) ⇒ AWS.Request
Search for associated transcripts that meet the specified criteria.
Service Reference:
Examples:
Calling the searchAssociatedTranscripts operation
var params = { botId: 'STRING_VALUE', /* required */ botRecommendationId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ filters: [ /* required */ { name: IntentId | SlotTypeId, /* required */ values: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], localeId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextIndex: 'NUMBER_VALUE', searchOrder: Ascending | Descending }; lexmodelsv2.searchAssociatedTranscripts(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot associated with the transcripts that you are searching.
botVersion
— (String
)The version of the bot containing the transcripts that you are searching.
localeId
— (String
)The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationId
— (String
)The unique identifier of the bot recommendation associated with the transcripts to search.
searchOrder
— (String
)How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
Possible values include:"Ascending"
"Descending"
filters
— (Array<map>
)A list of filter objects.
name
— required — (String
)The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.
Possible values include:"IntentId"
"SlotTypeId"
values
— required — (Array<String>
)The values to use to filter the transcript.
maxResults
— (Integer
)The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
nextIndex
— (Integer
)If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot associated with the transcripts that you are searching.
botVersion
— (String
)The version of the bot containing the transcripts that you are searching.
localeId
— (String
)The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationId
— (String
)The unique identifier of the bot recommendation associated with the transcripts to search.
nextIndex
— (Integer
)A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.
associatedTranscripts
— (Array<map>
)The object that contains the associated transcript that meet the criteria you specified.
transcript
— (String
)The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.
totalResults
— (Integer
)The total number of transcripts returned by the search.
-
(AWS.Response)
—
Returns:
startBotRecommendation(params = {}, callback) ⇒ AWS.Request
Use this to provide your transcript data, and to start the bot recommendation process.
Service Reference:
Examples:
Calling the startBotRecommendation operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ transcriptSourceSetting: { /* required */ s3BucketTranscriptSource: { s3BucketName: 'STRING_VALUE', /* required */ transcriptFormat: Lex, /* required */ kmsKeyArn: 'STRING_VALUE', pathFormat: { objectPrefixes: [ 'STRING_VALUE', /* more items */ ] }, transcriptFilter: { lexTranscriptFilter: { dateRangeFilter: { endDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ startDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */ } } } } }, encryptionSetting: { associatedTranscriptsPassword: 'STRING_VALUE', botLocaleExportPassword: 'STRING_VALUE', kmsKeyArn: 'STRING_VALUE' } }; lexmodelsv2.startBotRecommendation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot containing the bot recommendation.
botVersion
— (String
)The version of the bot containing the bot recommendation.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
transcriptSourceSetting
— (map
)The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource
— (map
)Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName
— required — (String
)The name of the bucket containing the transcript and the associated metadata.
pathFormat
— (map
)The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes
— (Array<String>
)A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
transcriptFormat
— required — (String
)The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
Possible values include:"Lex"
transcriptFilter
— (map
)The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter
— (map
)The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter
— (map
)The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime
— required — (Date
)A timestamp indicating the start date for the date range filter.
endDateTime
— required — (Date
)A timestamp indicating the end date for the date range filter.
kmsKeyArn
— (String
)The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting
— (map
)The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn
— (String
)The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword
— (String
)The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword
— (String
)The password used to encrypt the associated transcript file.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot containing the bot recommendation.
botVersion
— (String
)The version of the bot containing the bot recommendation.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus
— (String
)The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Possible values include:"Processing"
"Deleting"
"Deleted"
"Downloading"
"Updating"
"Available"
"Failed"
"Stopping"
"Stopped"
botRecommendationId
— (String
)The identifier of the bot recommendation that you have created.
creationDateTime
— (Date
)A timestamp of the date and time that the bot recommendation was created.
transcriptSourceSetting
— (map
)The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource
— (map
)Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName
— required — (String
)The name of the bucket containing the transcript and the associated metadata.
pathFormat
— (map
)The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes
— (Array<String>
)A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
transcriptFormat
— required — (String
)The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
Possible values include:"Lex"
transcriptFilter
— (map
)The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter
— (map
)The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter
— (map
)The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime
— required — (Date
)A timestamp indicating the start date for the date range filter.
endDateTime
— required — (Date
)A timestamp indicating the end date for the date range filter.
kmsKeyArn
— (String
)The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting
— (map
)The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn
— (String
)The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword
— (String
)The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword
— (String
)The password used to encrypt the associated transcript file.
-
(AWS.Response)
—
Returns:
startBotResourceGeneration(params = {}, callback) ⇒ AWS.Request
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the
DescribeBotResourceGeneration
operation to check on the status of the generation and for thegeneratedBotLocaleUrl
when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.Service Reference:
Examples:
Calling the startBotResourceGeneration operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ generationInputPrompt: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.startBotResourceGeneration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
generationInputPrompt
— (String
)The prompt to generate intents and slot types for the bot locale. Your description should be both detailed and precise to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.
botId
— (String
)The unique identifier of the bot for which to generate intents and slot types.
botVersion
— (String
)The version of the bot for which to generate intents and slot types.
localeId
— (String
)The locale of the bot for which to generate intents and slot types.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:generationInputPrompt
— (String
)The prompt that was used generate intents and slot types for the bot locale.
generationId
— (String
)The unique identifier of the generation request.
botId
— (String
)The unique identifier of the bot for which the generation request was made.
botVersion
— (String
)The version of the bot for which the generation request was made.
localeId
— (String
)The locale of the bot for which the generation request was made.
generationStatus
— (String
)The status of the generation request.
Possible values include:"Failed"
"Complete"
"InProgress"
creationDateTime
— (Date
)The date and time at which the generation request was made.
-
(AWS.Response)
—
Returns:
startImport(params = {}, callback) ⇒ AWS.Request
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
Service Reference:
Examples:
Calling the startImport operation
var params = { importId: 'STRING_VALUE', /* required */ mergeStrategy: Overwrite | FailOnConflict | Append, /* required */ resourceSpecification: { /* required */ botImportSpecification: { botName: 'STRING_VALUE', /* required */ dataPrivacy: { /* required */ childDirected: true || false /* required */ }, roleArn: 'STRING_VALUE', /* required */ botTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, idleSessionTTLInSeconds: 'NUMBER_VALUE', testBotAliasTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }, botLocaleImportSpecification: { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ nluIntentConfidenceThreshold: 'NUMBER_VALUE', voiceSettings: { voiceId: 'STRING_VALUE', /* required */ engine: standard | neural } }, customVocabularyImportSpecification: { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }, testSetImportResourceSpecification: { importInputLocation: { /* required */ s3BucketName: 'STRING_VALUE', /* required */ s3Path: 'STRING_VALUE' /* required */ }, modality: Text | Audio, /* required */ roleArn: 'STRING_VALUE', /* required */ storageLocation: { /* required */ s3BucketName: 'STRING_VALUE', /* required */ s3Path: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' }, testSetName: 'STRING_VALUE', /* required */ description: 'STRING_VALUE', testSetTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } } }, filePassword: 'STRING_VALUE' }; lexmodelsv2.startImport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
importId
— (String
)The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
resourceSpecification
— (map
)Parameters for creating the bot, bot locale or custom vocabulary.
botImportSpecification
— (map
)Parameters for importing a bot.
botName
— required — (String
)The name that Amazon Lex should use for the bot.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy
— required — (map
)By default, data stored by Amazon Lex is encrypted. The
DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags
— (map<String>
)A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation.testBotAliasTags
— (map<String>
)A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
botLocaleImportSpecification
— (map
)Parameters for importing a bot locale.
botId
— required — (String
)The identifier of the bot to import the locale to.
botVersion
— required — (String
)The version of the bot to import the locale to. This can only be the
DRAFT
version of the bot.localeId
— required — (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold
— (Float
)Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voiceSettings
— (map
)Defines settings for using an Amazon Polly voice to communicate with a user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
customVocabularyImportSpecification
— (map
)Provides the parameters required for importing a custom vocabulary.
botId
— required — (String
)The identifier of the bot to import the custom vocabulary to.
botVersion
— required — (String
)The version of the bot to import the custom vocabulary to.
localeId
— required — (String
)The identifier of the local to import the custom vocabulary to. The value must be
en_GB
.
testSetImportResourceSpecification
— (map
)Specifications for the test set that is imported.
testSetName
— required — (String
)The name of the test set.
description
— (String
)The description of the test set.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation
— required — (map
)Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation
— required — (map
)Contains information about the input location from where test-set should be imported.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket.
s3Path
— required — (String
)The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality
— required — (String
)Specifies whether the test-set being imported contains written or spoken data.
Possible values include:"Text"
"Audio"
testSetTags
— (map<String>
)A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
mergeStrategy
— (String
)The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is
Possible values include:FailOnConflict
existing resources are not overwritten and the import fails."Overwrite"
"FailOnConflict"
"Append"
filePassword
— (String
)The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importId
— (String
)A unique identifier for the import.
resourceSpecification
— (map
)The parameters used when importing the resource.
botImportSpecification
— (map
)Parameters for importing a bot.
botName
— required — (String
)The name that Amazon Lex should use for the bot.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy
— required — (map
)By default, data stored by Amazon Lex is encrypted. The
DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags
— (map<String>
)A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation.testBotAliasTags
— (map<String>
)A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
botLocaleImportSpecification
— (map
)Parameters for importing a bot locale.
botId
— required — (String
)The identifier of the bot to import the locale to.
botVersion
— required — (String
)The version of the bot to import the locale to. This can only be the
DRAFT
version of the bot.localeId
— required — (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold
— (Float
)Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voiceSettings
— (map
)Defines settings for using an Amazon Polly voice to communicate with a user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
customVocabularyImportSpecification
— (map
)Provides the parameters required for importing a custom vocabulary.
botId
— required — (String
)The identifier of the bot to import the custom vocabulary to.
botVersion
— required — (String
)The version of the bot to import the custom vocabulary to.
localeId
— required — (String
)The identifier of the local to import the custom vocabulary to. The value must be
en_GB
.
testSetImportResourceSpecification
— (map
)Specifications for the test set that is imported.
testSetName
— required — (String
)The name of the test set.
description
— (String
)The description of the test set.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation
— required — (map
)Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation
— required — (map
)Contains information about the input location from where test-set should be imported.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket.
s3Path
— required — (String
)The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality
— required — (String
)Specifies whether the test-set being imported contains written or spoken data.
Possible values include:"Text"
"Audio"
testSetTags
— (map<String>
)A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
mergeStrategy
— (String
)The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
Possible values include:FailOnConflict
existing resources are not overwritten and the import fails."Overwrite"
"FailOnConflict"
"Append"
importStatus
— (String
)The current status of the import. When the status is
Possible values include:Complete
the bot, bot alias, or custom vocabulary is ready to use."InProgress"
"Completed"
"Failed"
"Deleting"
creationDateTime
— (Date
)The date and time that the import request was created.
-
(AWS.Response)
—
Returns:
startTestExecution(params = {}, callback) ⇒ AWS.Request
The action to start test set execution.
Service Reference:
Examples:
Calling the startTestExecution operation
var params = { apiMode: Streaming | NonStreaming, /* required */ target: { /* required */ botAliasTarget: { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ } }, testSetId: 'STRING_VALUE', /* required */ testExecutionModality: Text | Audio }; lexmodelsv2.startTestExecution(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The test set Id for the test set execution.
target
— (map
)The target bot for the test set execution.
botAliasTarget
— (map
)Contains information about the bot alias used for the test execution.
botId
— required — (String
)The bot Id of the bot alias used in the test set execution.
botAliasId
— required — (String
)The bot alias Id of the bot alias used in the test set execution.
localeId
— required — (String
)The locale Id of the bot alias used in the test set execution.
apiMode
— (String
)Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
Possible values include:"Streaming"
"NonStreaming"
testExecutionModality
— (String
)Indicates whether audio or text is used.
Possible values include:"Text"
"Audio"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testExecutionId
— (String
)The unique identifier of the test set execution.
creationDateTime
— (Date
)The creation date and time for the test set execution.
testSetId
— (String
)The test set Id for the test set execution.
target
— (map
)The target bot for the test set execution.
botAliasTarget
— (map
)Contains information about the bot alias used for the test execution.
botId
— required — (String
)The bot Id of the bot alias used in the test set execution.
botAliasId
— required — (String
)The bot alias Id of the bot alias used in the test set execution.
localeId
— required — (String
)The locale Id of the bot alias used in the test set execution.
apiMode
— (String
)Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
Possible values include:"Streaming"
"NonStreaming"
testExecutionModality
— (String
)Indicates whether audio or text is used.
Possible values include:"Text"
"Audio"
-
(AWS.Response)
—
Returns:
startTestSetGeneration(params = {}, callback) ⇒ AWS.Request
The action to start the generation of test set.
Service Reference:
Examples:
Calling the startTestSetGeneration operation
var params = { generationDataSource: { /* required */ conversationLogsDataSource: { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ filter: { /* required */ endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ inputMode: Speech | Text, /* required */ startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */ }, localeId: 'STRING_VALUE' /* required */ } }, roleArn: 'STRING_VALUE', /* required */ storageLocation: { /* required */ s3BucketName: 'STRING_VALUE', /* required */ s3Path: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' }, testSetName: 'STRING_VALUE', /* required */ description: 'STRING_VALUE', testSetTags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; lexmodelsv2.startTestSetGeneration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetName
— (String
)The test set name for the test set generation request.
description
— (String
)The test set description for the test set generation request.
storageLocation
— (map
)The Amazon S3 storage location for the test set generation.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
generationDataSource
— (map
)The data source for the test set generation.
conversationLogsDataSource
— (map
)Contains information about the bot from which the conversation logs are sourced.
botId
— required — (String
)The bot Id from the conversation logs.
botAliasId
— required — (String
)The bot alias Id from the conversation logs.
localeId
— required — (String
)The locale Id of the conversation log.
filter
— required — (map
)The filter for the data source of the conversation log.
startTime
— required — (Date
)The start time for the conversation log.
endTime
— required — (Date
)The end time for the conversation log.
inputMode
— required — (String
)The selection to filter by input mode for the conversation logs.
Possible values include:"Speech"
"Text"
roleArn
— (String
)The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
testSetTags
— (map<String>
)A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetGenerationId
— (String
)The unique identifier of the test set generation to describe.
creationDateTime
— (Date
)The creation date and time for the test set generation.
testSetGenerationStatus
— (String
)The status for the test set generation.
Possible values include:"Generating"
"Ready"
"Failed"
"Pending"
testSetName
— (String
)The test set name used for the test set generation.
description
— (String
)The description used for the test set generation.
storageLocation
— (map
)The Amazon S3 storage location for the test set generation.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
generationDataSource
— (map
)The data source for the test set generation.
conversationLogsDataSource
— (map
)Contains information about the bot from which the conversation logs are sourced.
botId
— required — (String
)The bot Id from the conversation logs.
botAliasId
— required — (String
)The bot alias Id from the conversation logs.
localeId
— required — (String
)The locale Id of the conversation log.
filter
— required — (map
)The filter for the data source of the conversation log.
startTime
— required — (Date
)The start time for the conversation log.
endTime
— required — (Date
)The end time for the conversation log.
inputMode
— required — (String
)The selection to filter by input mode for the conversation logs.
Possible values include:"Speech"
"Text"
roleArn
— (String
)The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
testSetTags
— (map<String>
)A list of tags that was used for the test set that is being generated.
-
(AWS.Response)
—
Returns:
stopBotRecommendation(params = {}, callback) ⇒ AWS.Request
Stop an already running Bot Recommendation request.
Service Reference:
Examples:
Calling the stopBotRecommendation operation
var params = { botId: 'STRING_VALUE', /* required */ botRecommendationId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.stopBotRecommendation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot containing the bot recommendation to be stopped.
botVersion
— (String
)The version of the bot containing the bot recommendation.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationId
— (String
)The unique identifier of the bot recommendation to be stopped.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot containing the bot recommendation that is being stopped.
botVersion
— (String
)The version of the bot containing the recommendation that is being stopped.
localeId
— (String
)The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus
— (String
)The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Possible values include:"Processing"
"Deleting"
"Deleted"
"Downloading"
"Updating"
"Available"
"Failed"
"Stopping"
"Stopped"
botRecommendationId
— (String
)The unique identifier of the bot recommendation that is being stopped.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
Service Reference:
Examples:
Calling the tagResource operation
var params = { resourceARN: 'STRING_VALUE', /* required */ tags: { /* required */ '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; lexmodelsv2.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
tags
— (map<String>
)A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a bot, bot alias, or bot channel.
Service Reference:
Examples:
Calling the untagResource operation
var params = { resourceARN: 'STRING_VALUE', /* required */ tagKeys: [ /* required */ 'STRING_VALUE', /* more items */ ] }; lexmodelsv2.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the resource to remove the tags from.
tagKeys
— (Array<String>
)A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateBot(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing bot.
Service Reference:
Examples:
Calling the updateBot operation
var params = { botId: 'STRING_VALUE', /* required */ botName: 'STRING_VALUE', /* required */ dataPrivacy: { /* required */ childDirected: true || false /* required */ }, idleSessionTTLInSeconds: 'NUMBER_VALUE', /* required */ roleArn: 'STRING_VALUE', /* required */ botMembers: [ { botMemberAliasId: 'STRING_VALUE', /* required */ botMemberAliasName: 'STRING_VALUE', /* required */ botMemberId: 'STRING_VALUE', /* required */ botMemberName: 'STRING_VALUE', /* required */ botMemberVersion: 'STRING_VALUE' /* required */ }, /* more items */ ], botType: Bot | BotNetwork, description: 'STRING_VALUE' }; lexmodelsv2.updateBot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
botName
— (String
)The new name of the bot. The name must be unique in the account that creates the bot.
description
— (String
)A description of the bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
dataPrivacy
— (map
)Provides information on additional privacy protections Amazon Lex should use with the bot's data.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botType
— (String
)The type of the bot to be updated.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bot members in the network associated with the update action.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot that was updated.
botName
— (String
)The name of the bot after the update.
description
— (String
)The description of the bot after the update.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
dataPrivacy
— (map
)The data privacy settings for the bot after the update.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The session timeout, in seconds, for the bot after the update.
botStatus
— (String
)Shows the current status of the bot. The bot is first in the
Possible values include:Creating
status. Once the bot is read for use, it changes to theAvailable
status. After the bot is created, you can use theDRAFT
version of the bot."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp of the date and time that the bot was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot was last updated.
botType
— (String
)The type of the bot that was updated.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bot members in the network that was updated.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
-
(AWS.Response)
—
Returns:
updateBotAlias(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing bot alias.
Service Reference:
Examples:
Calling the updateBotAlias operation
var params = { botAliasId: 'STRING_VALUE', /* required */ botAliasName: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE', /* required */ botAliasLocaleSettings: { '<LocaleId>': { enabled: true || false, /* required */ codeHookSpecification: { lambdaCodeHook: { /* required */ codeHookInterfaceVersion: 'STRING_VALUE', /* required */ lambdaARN: 'STRING_VALUE' /* required */ } } }, /* '<LocaleId>': ... */ }, botVersion: 'STRING_VALUE', conversationLogSettings: { audioLogSettings: [ { destination: { /* required */ s3Bucket: { /* required */ logPrefix: 'STRING_VALUE', /* required */ s3BucketArn: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' } }, enabled: true || false, /* required */ selectiveLoggingEnabled: true || false }, /* more items */ ], textLogSettings: [ { destination: { /* required */ cloudWatch: { /* required */ cloudWatchLogGroupArn: 'STRING_VALUE', /* required */ logPrefix: 'STRING_VALUE' /* required */ } }, enabled: true || false, /* required */ selectiveLoggingEnabled: true || false }, /* more items */ ] }, description: 'STRING_VALUE', sentimentAnalysisSettings: { detectSentiment: true || false /* required */ } }; lexmodelsv2.updateBotAlias(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botAliasId
— (String
)The unique identifier of the bot alias.
botAliasName
— (String
)The new name to assign to the bot alias.
description
— (String
)The new description to assign to the bot alias.
botVersion
— (String
)The new bot version to assign to the bot alias.
botAliasLocaleSettings
— (map<map>
)The new Lambda functions to use in each locale for the bot alias.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botId
— (String
)The identifier of the bot with the updated alias.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasId
— (String
)The identifier of the updated bot alias.
botAliasName
— (String
)The updated name of the bot alias.
description
— (String
)The updated description of the bot alias.
botVersion
— (String
)The updated version of the bot that the alias points to.
botAliasLocaleSettings
— (map<map>
)The updated Lambda functions to use in each locale for the bot alias.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botAliasStatus
— (String
)The current status of the bot alias. When the status is
Possible values include:Available
the alias is ready for use."Creating"
"Available"
"Deleting"
"Failed"
botId
— (String
)The identifier of the bot with the updated alias.
creationDateTime
— (Date
)A timestamp of the date and time that the bot was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot was last updated.
-
(AWS.Response)
—
Returns:
updateBotLocale(params = {}, callback) ⇒ AWS.Request
Updates the settings that a bot has for a specific locale.
Service Reference:
Examples:
Calling the updateBotLocale operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ nluIntentConfidenceThreshold: 'NUMBER_VALUE', /* required */ description: 'STRING_VALUE', generativeAISettings: { buildtimeSettings: { descriptiveBotBuilder: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } }, sampleUtteranceGeneration: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } } }, runtimeSettings: { slotResolutionImprovement: { enabled: true || false, /* required */ bedrockModelSpecification: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED } } } }, voiceSettings: { voiceId: 'STRING_VALUE', /* required */ engine: standard | neural } }; lexmodelsv2.updateBotLocale(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot that contains the locale.
botVersion
— (String
)The version of the bot that contains the locale to be updated. The version can only be the
DRAFT
version.localeId
— (String
)The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.
description
— (String
)The new description of the locale.
nluIntentConfidenceThreshold
— (Float
)The new confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
generativeAISettings
— (map
)Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the updated locale.
botVersion
— (String
)The version of the bot that contains the updated locale.
localeId
— (String
)The language and locale of the updated bot locale.
localeName
— (String
)The updated locale name for the locale.
description
— (String
)The updated description of the locale.
nluIntentConfidenceThreshold
— (Float
)The updated confidence threshold for inserting the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The updated Amazon Polly voice to use for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
botLocaleStatus
— (String
)The current status of the locale. When the bot status is
Possible values include:Built
the locale is ready for use."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
failureReasons
— (Array<String>
)If the
botLocaleStatus
isFailed
, thefailureReasons
field lists the errors that occurred while building the bot.creationDateTime
— (Date
)A timestamp of the date and time that the locale was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the locale was last updated.
recommendedActions
— (Array<String>
)Recommended actions to take to resolve an error in the
failureReasons
field.generativeAISettings
— (map
)Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
updateBotRecommendation(params = {}, callback) ⇒ AWS.Request
Updates an existing bot recommendation request.
Service Reference:
Examples:
Calling the updateBotRecommendation operation
var params = { botId: 'STRING_VALUE', /* required */ botRecommendationId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ encryptionSetting: { /* required */ associatedTranscriptsPassword: 'STRING_VALUE', botLocaleExportPassword: 'STRING_VALUE', kmsKeyArn: 'STRING_VALUE' }, localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.updateBotRecommendation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
botId
— (String
)The unique identifier of the bot containing the bot recommendation to be updated.
botVersion
— (String
)The version of the bot containing the bot recommendation to be updated.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationId
— (String
)The unique identifier of the bot recommendation to be updated.
encryptionSetting
— (map
)The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn
— (String
)The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword
— (String
)The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword
— (String
)The password used to encrypt the associated transcript file.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot containing the bot recommendation that has been updated.
botVersion
— (String
)The version of the bot containing the bot recommendation that has been updated.
localeId
— (String
)The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
botRecommendationStatus
— (String
)The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Possible values include:"Processing"
"Deleting"
"Deleted"
"Downloading"
"Updating"
"Available"
"Failed"
"Stopping"
"Stopped"
botRecommendationId
— (String
)The unique identifier of the bot recommendation to be updated.
creationDateTime
— (Date
)A timestamp of the date and time that the bot recommendation was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot recommendation was last updated.
transcriptSourceSetting
— (map
)The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
s3BucketTranscriptSource
— (map
)Indicates the setting of the Amazon S3 bucket where the transcript is stored.
s3BucketName
— required — (String
)The name of the bucket containing the transcript and the associated metadata.
pathFormat
— (map
)The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
objectPrefixes
— (Array<String>
)A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
transcriptFormat
— required — (String
)The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
Possible values include:"Lex"
transcriptFilter
— (map
)The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
lexTranscriptFilter
— (map
)The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
dateRangeFilter
— (map
)The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
startDateTime
— required — (Date
)A timestamp indicating the start date for the date range filter.
endDateTime
— required — (Date
)A timestamp indicating the end date for the date range filter.
kmsKeyArn
— (String
)The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
encryptionSetting
— (map
)The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
kmsKeyArn
— (String
)The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
botLocaleExportPassword
— (String
)The password used to encrypt the recommended bot recommendation file.
associatedTranscriptsPassword
— (String
)The password used to encrypt the associated transcript file.
-
(AWS.Response)
—
Returns:
updateExport(params = {}, callback) ⇒ AWS.Request
Updates the password used to protect an export zip archive.
The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.
Service Reference:
Examples:
Calling the updateExport operation
var params = { exportId: 'STRING_VALUE', /* required */ filePassword: 'STRING_VALUE' }; lexmodelsv2.updateExport(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
exportId
— (String
)The unique identifier Amazon Lex assigned to the export.
filePassword
— (String
)The new password to use to encrypt the export zip archive.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:exportId
— (String
)The unique identifier Amazon Lex assigned to the export.
resourceSpecification
— (map
)A description of the type of resource that was exported, either a bot or a bot locale.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format used for the files that define the resource. The
Possible values include:TSV
format is required to export a custom vocabulary only; otherwise useLexJson
format."LexJson"
"TSV"
"CSV"
exportStatus
— (String
)The status of the export. When the status is
Possible values include:Completed
the export archive is available for download."InProgress"
"Completed"
"Failed"
"Deleting"
creationDateTime
— (Date
)The date and time that the export was created.
lastUpdatedDateTime
— (Date
)The date and time that the export was last updated.
-
(AWS.Response)
—
Returns:
updateIntent(params = {}, callback) ⇒ AWS.Request
Updates the settings for an intent.
Service Reference:
Examples:
Calling the updateIntent operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ intentName: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ description: 'STRING_VALUE', dialogCodeHook: { enabled: true || false /* required */ }, fulfillmentCodeHook: { enabled: true || false, /* required */ active: true || false, fulfillmentUpdatesSpecification: { active: true || false, /* required */ startResponse: { delayInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutInSeconds: 'NUMBER_VALUE', updateResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, postFulfillmentStatusSpecification: { failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, initialResponseSetting: { codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, conditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, initialResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } } }, inputContexts: [ { name: 'STRING_VALUE' /* required */ }, /* more items */ ], intentClosingSetting: { active: true || false, closingResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, conditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } } }, intentConfirmationSetting: { promptSpecification: { /* required */ maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, active: true || false, codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, confirmationConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, confirmationNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, confirmationResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, declinationConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, declinationNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, declinationResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, elicitationCodeHook: { enableCodeHookInvocation: true || false, /* required */ invocationLabel: 'STRING_VALUE' }, failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, kendraConfiguration: { kendraIndex: 'STRING_VALUE', /* required */ queryFilterString: 'STRING_VALUE', queryFilterStringEnabled: true || false }, outputContexts: [ { name: 'STRING_VALUE', /* required */ timeToLiveInSeconds: 'NUMBER_VALUE', /* required */ turnsToLive: 'NUMBER_VALUE' /* required */ }, /* more items */ ], parentIntentSignature: 'STRING_VALUE', qnAIntentConfiguration: { bedrockModelConfiguration: { modelArn: 'STRING_VALUE', /* required */ customPrompt: 'STRING_VALUE', guardrail: { identifier: 'STRING_VALUE', /* required */ version: 'STRING_VALUE' /* required */ }, traceStatus: ENABLED | DISABLED }, dataSourceConfiguration: { bedrockKnowledgeStoreConfiguration: { bedrockKnowledgeBaseArn: 'STRING_VALUE', /* required */ exactResponse: true || false, exactResponseFields: { answerField: 'STRING_VALUE' } }, kendraConfiguration: { kendraIndex: 'STRING_VALUE', /* required */ exactResponse: true || false, queryFilterString: 'STRING_VALUE', queryFilterStringEnabled: true || false }, opensearchConfiguration: { domainEndpoint: 'STRING_VALUE', /* required */ indexName: 'STRING_VALUE', /* required */ exactResponse: true || false, exactResponseFields: { answerField: 'STRING_VALUE', /* required */ questionField: 'STRING_VALUE' /* required */ }, includeFields: [ 'STRING_VALUE', /* more items */ ] } } }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ], slotPriorities: [ { priority: 'NUMBER_VALUE', /* required */ slotId: 'STRING_VALUE' /* required */ }, /* more items */ ] }; lexmodelsv2.updateIntent(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
intentId
— (String
)The unique identifier of the intent to update.
intentName
— (String
)The new name for the intent.
description
— (String
)The new description of the intent.
parentIntentSignature
— (String
)The signature of the new built-in intent to use as the parent of this intent.
sampleUtterances
— (Array<map>
)New utterances used to invoke the intent.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook
— (map
)The new Lambda function to use between each turn of the conversation with the bot.
enabled
— required — (Boolean
)Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook
— (map
)The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
enabled
— required — (Boolean
)Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification
— (map
)Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the fulfillment code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the fulfillment code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
fulfillmentUpdatesSpecification
— (map
)Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active
— required — (Boolean
)Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required.startResponse
— (map
)Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds
— required — (Integer
)The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt the start message while it is playing.
updateResponse
— (map
)Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds
— required — (Integer
)The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds
— (Integer
)The length of time that the fulfillment Lambda function should run before it times out.
active
— (Boolean
)Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run.
slotPriorities
— (Array<map>
)A new list of slots and their priorities that are contained by the intent.
priority
— required — (Integer
)The priority that Amazon Lex should apply to the slot.
slotId
— required — (String
)The unique identifier of the slot.
intentConfirmationSetting
— (map
)New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
promptSpecification
— required — (map
)Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
declinationResponse
— (map
)When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true.confirmationResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
confirmationNextStep
— (map
)Specifies the next step that the bot executes when the customer confirms the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
confirmationConditional
— (map
)A list of conditional branches to evaluate after the intent is closed.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
declinationNextStep
— (map
)Specifies the next step that the bot executes when the customer declines the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
declinationConditional
— (map
)A list of conditional branches to evaluate after the intent is declined.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)The next step to take in the conversation if the confirmation step fails.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
intentClosingSetting
— (map
)The new response that Amazon Lex sends the user when the intent is closed.
closingResponse
— (map
)The response that Amazon Lex sends to the user when the intent is complete.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true.nextStep
— (map
)Specifies the next step that the bot executes after playing the intent's closing response.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
inputContexts
— (Array<map>
)A new list of contexts that must be active in order for Amazon Lex to consider the intent.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)A new list of contexts that Amazon Lex activates when the intent is fulfilled.
name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration
— (map
)New configuration settings for connecting to an Amazon Kendra index.
kendraIndex
— required — (String
)The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot.queryFilterStringEnabled
— (Boolean
)Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.queryFilterString
— (String
)A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
botId
— (String
)The identifier of the bot that contains the intent.
botVersion
— (String
)The version of the bot that contains the intent. Must be
DRAFT
.localeId
— (String
)The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.
initialResponseSetting
— (map
)Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
initialResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
qnAIntentConfiguration
— (map
)Specifies the configuration of the built-in
Amazon.QnAIntent
. TheAMAZON.QnAIntent
intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify thekendraConfiguration
field.dataSourceConfiguration
— (map
)Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.opensearchConfiguration
— (map
)Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.domainEndpoint
— required — (String
)The endpoint of the Amazon OpenSearch Service domain.
indexName
— required — (String
)The name of the Amazon OpenSearch Service index.
exactResponse
— (Boolean
)Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
questionField
— required — (String
)The name of the field that contains the query made to the OpenSearch Service database.
answerField
— required — (String
)The name of the field that contains the answer to the query made to the OpenSearch Service database.
includeFields
— (Array<String>
)Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
kendraConfiguration
— (map
)Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index.kendraIndex
— required — (String
)The ARN of the Amazon Kendra index to use.
queryFilterStringEnabled
— (Boolean
)Specifies whether to enable an Amazon Kendra filter string or not.
queryFilterString
— (String
)Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
exactResponse
— (Boolean
)Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
bedrockKnowledgeStoreConfiguration
— (map
)Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base.bedrockKnowledgeBaseArn
— required — (String
)The base ARN of the knowledge base used.
exactResponse
— (Boolean
)Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
answerField
— (String
)The answer field used for an exact response from Bedrock Knowledge Store.
bedrockModelConfiguration
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:intentId
— (String
)The identifier of the intent that was updated.
intentName
— (String
)The updated name of the intent.
description
— (String
)The updated description of the intent.
parentIntentSignature
— (String
)The updated built-in intent that is the parent of this intent.
sampleUtterances
— (Array<map>
)The updated list of sample utterances for the intent.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook
— (map
)The updated Lambda function called during each turn of the conversation with the user.
enabled
— required — (Boolean
)Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook
— (map
)The updated Lambda function called when the intent is ready for fulfillment.
enabled
— required — (Boolean
)Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification
— (map
)Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the fulfillment code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the fulfillment code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
fulfillmentUpdatesSpecification
— (map
)Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active
— required — (Boolean
)Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required.startResponse
— (map
)Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds
— required — (Integer
)The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt the start message while it is playing.
updateResponse
— (map
)Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds
— required — (Integer
)The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups
— required — (Array<map>
)1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
)Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds
— (Integer
)The length of time that the fulfillment Lambda function should run before it times out.
active
— (Boolean
)Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run.
slotPriorities
— (Array<map>
)The updated list of slots and their priorities that are elicited from the user for the intent.
priority
— required — (Integer
)The priority that Amazon Lex should apply to the slot.
slotId
— required — (String
)The unique identifier of the slot.
intentConfirmationSetting
— (map
)The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
promptSpecification
— required — (map
)Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
declinationResponse
— (map
)When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled.messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true.confirmationResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
confirmationNextStep
— (map
)Specifies the next step that the bot executes when the customer confirms the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
confirmationConditional
— (map
)A list of conditional branches to evaluate after the intent is closed.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
declinationNextStep
— (map
)Specifies the next step that the bot executes when the customer declines the intent.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
declinationConditional
— (map
)A list of conditional branches to evaluate after the intent is declined.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)The next step to take in the conversation if the confirmation step fails.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries.enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
intentClosingSetting
— (map
)The updated response that Amazon Lex sends the user when the intent is closed.
closingResponse
— (map
)The response that Amazon Lex sends to the user when the intent is complete.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
active
— (Boolean
)Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true.nextStep
— (map
)Specifies the next step that the bot executes after playing the intent's closing response.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
inputContexts
— (Array<map>
)The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
name
— required — (String
)The name of the context.
outputContexts
— (Array<map>
)The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
name
— required — (String
)The name of the output context.
timeToLiveInSeconds
— required — (Integer
)The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive
— required — (Integer
)The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration
— (map
)The updated configuration for connecting to an Amazon Kendra index with the
AMAZON.KendraSearchIntent
intent.kendraIndex
— required — (String
)The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot.queryFilterStringEnabled
— (Boolean
)Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.queryFilterString
— (String
)A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
botId
— (String
)The identifier of the bot that contains the intent.
botVersion
— (String
)The version of the bot that contains the intent. Will always be
DRAFT
.localeId
— (String
)The updated language and locale of the intent.
creationDateTime
— (Date
)A timestamp of when the intent was created.
lastUpdatedDateTime
— (Date
)A timestamp of the last time that the intent was modified.
initialResponseSetting
— (map
)Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
initialResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
conditional
— (map
)Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
qnAIntentConfiguration
— (map
)Details about the configuration of the built-in
Amazon.QnAIntent
.dataSourceConfiguration
— (map
)Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.opensearchConfiguration
— (map
)Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.domainEndpoint
— required — (String
)The endpoint of the Amazon OpenSearch Service domain.
indexName
— required — (String
)The name of the Amazon OpenSearch Service index.
exactResponse
— (Boolean
)Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
questionField
— required — (String
)The name of the field that contains the query made to the OpenSearch Service database.
answerField
— required — (String
)The name of the field that contains the answer to the query made to the OpenSearch Service database.
includeFields
— (Array<String>
)Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
kendraConfiguration
— (map
)Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index.kendraIndex
— required — (String
)The ARN of the Amazon Kendra index to use.
queryFilterStringEnabled
— (Boolean
)Specifies whether to enable an Amazon Kendra filter string or not.
queryFilterString
— (String
)Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
exactResponse
— (Boolean
)Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
bedrockKnowledgeStoreConfiguration
— (map
)Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base.bedrockKnowledgeBaseArn
— required — (String
)The base ARN of the knowledge base used.
exactResponse
— (Boolean
)Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
exactResponseFields
— (map
)Contains the names of the fields used for an exact response to the user.
answerField
— (String
)The answer field used for an exact response from Bedrock Knowledge Store.
bedrockModelConfiguration
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
updateResourcePolicy(params = {}, callback) ⇒ AWS.Request
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
Service Reference:
Examples:
Calling the updateResourcePolicy operation
var params = { policy: 'STRING_VALUE', /* required */ resourceArn: 'STRING_VALUE', /* required */ expectedRevisionId: 'STRING_VALUE' }; lexmodelsv2.updateResourcePolicy(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy
— (String
)A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
If the policy isn't valid, Amazon Lex returns a validation exception.
expectedRevisionId
— (String
)The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:resourceArn
— (String
)The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
revisionId
— (String
)The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
-
(AWS.Response)
—
Returns:
updateSlot(params = {}, callback) ⇒ AWS.Request
Updates the settings for a slot.
Service Reference:
Examples:
Calling the updateSlot operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ intentId: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotId: 'STRING_VALUE', /* required */ slotName: 'STRING_VALUE', /* required */ valueElicitationSetting: { /* required */ slotConstraint: Required | Optional, /* required */ defaultValueSpecification: { defaultValueList: [ /* required */ { defaultValue: 'STRING_VALUE' /* required */ }, /* more items */ ] }, promptSpecification: { maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ], slotCaptureSetting: { captureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, captureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, captureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, codeHook: { active: true || false, /* required */ enableCodeHookInvocation: true || false, /* required */ postCodeHookSpecification: { /* required */ failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, successConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, successNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, successResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, timeoutConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, timeoutNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, timeoutResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, invocationLabel: 'STRING_VALUE' }, elicitationCodeHook: { enableCodeHookInvocation: true || false, /* required */ invocationLabel: 'STRING_VALUE' }, failureConditional: { active: true || false, /* required */ conditionalBranches: [ /* required */ { condition: { /* required */ expressionString: 'STRING_VALUE' /* required */ }, name: 'STRING_VALUE', /* required */ nextStep: { /* required */ dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, /* more items */ ], defaultBranch: { /* required */ nextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, response: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } } }, failureNextStep: { dialogAction: { type: ElicitIntent | StartIntent | ElicitSlot | EvaluateConditional | InvokeDialogCodeHook | ConfirmIntent | FulfillIntent | CloseIntent | EndConversation, /* required */ slotToElicit: 'STRING_VALUE', suppressNextMessage: true || false }, intent: { name: 'STRING_VALUE', slots: { '<Name>': { /* SlotValueOverride */ shape: Scalar | List, value: { interpretedValue: 'STRING_VALUE' }, values: [ /* recursive SlotValueOverride */, /* more items */ ] }, /* '<Name>': ... */ } }, sessionAttributes: { '<NonEmptyString>': 'STRING_VALUE', /* '<NonEmptyString>': ... */ } }, failureResponse: { messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false } }, slotResolutionSetting: { slotResolutionStrategy: EnhancedFallback | Default /* required */ }, waitAndContinueSpecification: { continueResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, waitingResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, active: true || false, stillWaitingResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], timeoutInSeconds: 'NUMBER_VALUE', /* required */ allowInterrupt: true || false } } }, description: 'STRING_VALUE', multipleValuesSetting: { allowMultipleValues: true || false }, obfuscationSetting: { obfuscationSettingType: None | DefaultObfuscation /* required */ }, slotTypeId: 'STRING_VALUE', subSlotSetting: { expression: 'STRING_VALUE', slotSpecifications: { '<Name>': { slotTypeId: 'STRING_VALUE', /* required */ valueElicitationSetting: { /* required */ promptSpecification: { /* required */ maxRetries: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false, messageSelectionStrategy: Random | Ordered, promptAttemptsSpecification: { '<PromptAttempt>': { allowedInputTypes: { /* required */ allowAudioInput: true || false, /* required */ allowDTMFInput: true || false /* required */ }, allowInterrupt: true || false, audioAndDTMFInputSpecification: { startTimeoutMs: 'NUMBER_VALUE', /* required */ audioSpecification: { endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLengthMs: 'NUMBER_VALUE' /* required */ }, dtmfSpecification: { deletionCharacter: 'STRING_VALUE', /* required */ endCharacter: 'STRING_VALUE', /* required */ endTimeoutMs: 'NUMBER_VALUE', /* required */ maxLength: 'NUMBER_VALUE' /* required */ } }, textInputSpecification: { startTimeoutMs: 'NUMBER_VALUE' /* required */ } }, /* '<PromptAttempt>': ... */ } }, defaultValueSpecification: { defaultValueList: [ /* required */ { defaultValue: 'STRING_VALUE' /* required */ }, /* more items */ ] }, sampleUtterances: [ { utterance: 'STRING_VALUE' /* required */ }, /* more items */ ], waitAndContinueSpecification: { continueResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, waitingResponse: { /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], allowInterrupt: true || false }, active: true || false, stillWaitingResponse: { frequencyInSeconds: 'NUMBER_VALUE', /* required */ messageGroups: [ /* required */ { message: { /* required */ customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, variations: [ { customPayload: { value: 'STRING_VALUE' /* required */ }, imageResponseCard: { title: 'STRING_VALUE', /* required */ buttons: [ { text: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], imageUrl: 'STRING_VALUE', subtitle: 'STRING_VALUE' }, plainTextMessage: { value: 'STRING_VALUE' /* required */ }, ssmlMessage: { value: 'STRING_VALUE' /* required */ } }, /* more items */ ] }, /* more items */ ], timeoutInSeconds: 'NUMBER_VALUE', /* required */ allowInterrupt: true || false } } } }, /* '<Name>': ... */ } } }; lexmodelsv2.updateSlot(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotId
— (String
)The unique identifier for the slot to update.
slotName
— (String
)The new name for the slot.
description
— (String
)The new description for the slot.
slotTypeId
— (String
)The unique identifier of the new slot type to associate with this slot.
valueElicitationSetting
— (map
)A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
defaultValueSpecification
— (map
)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, session attributes, and defined values.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
slotConstraint
— required — (String
)Specifies whether the slot is required or optional.
Possible values include:"Required"
"Optional"
promptSpecification
— (map
)The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)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.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
slotCaptureSetting
— (map
)Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
captureNextStep
— (map
)Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
captureConditional
— (map
)A list of conditional branches to evaluate after the slot value is captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate when the slot value isn't captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)Code hook called when Amazon Lex doesn't capture a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
slotResolutionSetting
— (map
)An object containing information about whether assisted slot resolution is turned on for the slot or not.
slotResolutionStrategy
— required — (String
)Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
Possible values include:EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off."EnhancedFallback"
"Default"
obfuscationSetting
— (map
)New settings that determine how slot values are formatted in Amazon CloudWatch logs.
obfuscationSettingType
— required — (String
)Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Possible values include:"None"
"DefaultObfuscation"
botId
— (String
)The unique identifier of the bot that contains the slot.
botVersion
— (String
)The version of the bot that contains the slot. Must always be
DRAFT
.localeId
— (String
)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.
intentId
— (String
)The identifier of the intent that contains the slot.
multipleValuesSetting
— (map
)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 aValidationException
.If the
multipleValuesSetting
is not set, the default value isfalse
.allowMultipleValues
— (Boolean
)Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, 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 aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
subSlotSetting
— (map
)Specifications for the constituent sub slots and the expression for the composite slot.
expression
— (String
)The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
slotSpecifications
— (map<map>
)Specifications for the constituent sub slots of a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to the slot type.
valueElicitationSetting
— required — (map
)Specifies the elicitation setting details for constituent sub slots of a composite slot.
defaultValueSpecification
— (map
)Defines a list of values that Amazon Lex should use as the default value for a slot.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
promptSpecification
— required — (map
)Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots.utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (map
)The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
defaultValueSpecification
— (map
)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, session attributes, and defined values.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
slotConstraint
— required — (String
)Specifies whether the slot is required or optional.
Possible values include:"Required"
"Optional"
promptSpecification
— (map
)The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)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.
utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
slotCaptureSetting
— (map
)Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
captureNextStep
— (map
)Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
captureConditional
— (map
)A list of conditional branches to evaluate after the slot value is captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate when the slot value isn't captured.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
codeHook
— (map
)Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
active
— required — (Boolean
)Determines whether a dialog code hook is used when the intent is activated.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification
— required — (map
)Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
successNextStep
— (map
)Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
successConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
failureNextStep
— (map
)Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
failureConditional
— (map
)A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutResponse
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
timeoutNextStep
— (map
)Specifies the next step that the bot runs when the code hook times out.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
timeoutConditional
— (map
)A list of conditional branches to evaluate if the code hook times out.
active
— required — (Boolean
)Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches
— required — (Array<map>
)A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
name
— required — (String
)The name of the branch.
condition
— required — (map
)Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
expressionString
— required — (String
)The expression string that is evaluated.
nextStep
— required — (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
defaultBranch
— required — (map
)The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep
— (map
)The next step in the conversation.
dialogAction
— (map
)Defines the action that the bot executes at runtime when the conversation reaches this step.
type
— required — (String
)The action that the bot should execute.
Possible values include:"ElicitIntent"
"StartIntent"
"ElicitSlot"
"EvaluateConditional"
"InvokeDialogCodeHook"
"ConfirmIntent"
"FulfillIntent"
"CloseIntent"
"EndConversation"
slotToElicit
— (String
)If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage
— (Boolean
)When true the next message for the intent is not used.
intent
— (map
)Override settings to configure the intent state.
name
— (String
)The name of the intent. Only required when you're switching intents.
slots
— (map<map>
)A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
shape
— (String
)When the shape value is
Possible values include:List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value."Scalar"
"List"
value
— (map
)The current value of the slot.
interpretedValue
— (String
)The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
values
— (Array<map>
)A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
sessionAttributes
— (map<String>
)Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
response
— (map
)Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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.
elicitationCodeHook
— (map
)Code hook called when Amazon Lex doesn't capture a slot value.
enableCodeHookInvocation
— required — (Boolean
)Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel
— (String
)A label that indicates the dialog step from which the dialog code hook is happening.
slotResolutionSetting
— (map
)An object containing information about whether assisted slot resolution is turned on for the slot or not.
slotResolutionStrategy
— required — (String
)Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
Possible values include:EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off."EnhancedFallback"
"Default"
obfuscationSetting
— (map
)The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
obfuscationSettingType
— required — (String
)Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Possible values include:"None"
"DefaultObfuscation"
botId
— (String
)The identifier of the bot that contains the slot.
botVersion
— (String
)The version of the bot 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
— (Date
)The timestamp of the date and time that the slot was created.
lastUpdatedDateTime
— (Date
)The timestamp of the date and time that the slot was last updated.
multipleValuesSetting
— (map
)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. Whenfalse
, 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 aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
subSlotSetting
— (map
)Specifications for the constituent sub slots and the expression for the composite slot.
expression
— (String
)The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
slotSpecifications
— (map<map>
)Specifications for the constituent sub slots of a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to the slot type.
valueElicitationSetting
— required — (map
)Specifies the elicitation setting details for constituent sub slots of a composite slot.
defaultValueSpecification
— (map
)Defines a list of values that Amazon Lex should use as the default value for a slot.
defaultValueList
— required — (Array<map>
)A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
defaultValue
— required — (String
)The default value to use when a user doesn't provide a value for a slot.
promptSpecification
— required — (map
)Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
messageGroups
— required — (Array<map>
)A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy
— (String
)Indicates how a message is selected from a message group among retries.
Possible values include:"Random"
"Ordered"
promptAttemptsSpecification
— (map<map>
)Specifies the advanced settings on each attempt of the prompt.
allowInterrupt
— (Boolean
)Indicates whether the user can interrupt a speech prompt attempt from the bot.
allowedInputTypes
— required — (map
)Indicates the allowed input types of the prompt attempt.
allowAudioInput
— required — (Boolean
)Indicates whether audio input is allowed.
allowDTMFInput
— required — (Boolean
)Indicates whether DTMF input is allowed.
audioAndDTMFInputSpecification
— (map
)Specifies the settings on audio and DTMF input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
audioSpecification
— (map
)Specifies the settings on audio input.
maxLengthMs
— required — (Integer
)Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
endTimeoutMs
— required — (Integer
)Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
dtmfSpecification
— (map
)Specifies the settings on DTMF input.
maxLength
— required — (Integer
)The maximum number of DTMF digits allowed in an utterance.
endTimeoutMs
— required — (Integer
)How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
deletionCharacter
— required — (String
)The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
endCharacter
— required — (String
)The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
textInputSpecification
— (map
)Specifies the settings on text input.
startTimeoutMs
— required — (Integer
)Time for which a bot waits before re-prompting a customer for text input.
sampleUtterances
— (Array<map>
)If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots.utterance
— required — (String
)The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification
— (map
)Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse
— required — (map
)The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (map
)The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups
— required — (Array<map>
)A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (map
)A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups
— required — (Array<map>
)One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
message
— required — (map
)The primary message that Amazon Lex should send to the user.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— (Array<map>
)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.
plainTextMessage
— (map
)A message in plain text format.
value
— required — (String
)The message to send to the user.
customPayload
— (map
)A message in a custom format defined by the client application.
value
— required — (String
)The string that is sent to your application.
ssmlMessage
— (map
)A message in Speech Synthesis Markup Language (SSML).
value
— required — (String
)The SSML text that defines the prompt.
imageResponseCard
— (map
)A message that defines a response card that the client application can show to the user.
title
— required — (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
— (Array<map>
)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.
text
— required — (String
)The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value
— required — (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
— required — (Integer
)How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds
— required — (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.
active
— (Boolean
)Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true.
-
(AWS.Response)
—
Returns:
updateSlotType(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing slot type.
Service Reference:
Examples:
Calling the updateSlotType operation
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE', /* required */ slotTypeId: 'STRING_VALUE', /* required */ slotTypeName: 'STRING_VALUE', /* required */ compositeSlotTypeSetting: { subSlots: [ { name: 'STRING_VALUE', /* required */ slotTypeId: 'STRING_VALUE' /* required */ }, /* more items */ ] }, description: 'STRING_VALUE', externalSourceSetting: { grammarSlotTypeSetting: { source: { s3BucketName: 'STRING_VALUE', /* required */ s3ObjectKey: 'STRING_VALUE', /* required */ kmsKeyArn: 'STRING_VALUE' } } }, parentSlotTypeSignature: 'STRING_VALUE', slotTypeValues: [ { sampleValue: { value: 'STRING_VALUE' /* required */ }, synonyms: [ { value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, /* more items */ ], valueSelectionSetting: { resolutionStrategy: OriginalValue | TopResolution | Concatenation, /* required */ advancedRecognitionSetting: { audioRecognitionStrategy: UseSlotValuesAsCustomVocabulary }, regexFilter: { pattern: 'STRING_VALUE' /* required */ } } }; lexmodelsv2.updateSlotType(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
slotTypeId
— (String
)The unique identifier of the slot type to update.
slotTypeName
— (String
)The new name of the slot type.
description
— (String
)The new description of the slot type.
slotTypeValues
— (Array<map>
)A new list of values and their optional synonyms that define the values that the slot type can take.
sampleValue
— (map
)The value of the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
synonyms
— (Array<map>
)Additional values related to the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
valueSelectionSetting
— (map
)The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
resolutionStrategy
— required — (String
)Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
Possible values include:valueSelectionStrategy
, the default isORIGINAL_VALUE
."OriginalValue"
"TopResolution"
"Concatenation"
-
regexFilter
— (map
)A regular expression used to validate the value of a slot.
pattern
— required — (String
)A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or
{x,}
with no upper bound. -
Wild card (.)
-
advancedRecognitionSetting
— (map
)Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
audioRecognitionStrategy
— (String
)Enables using the slot values as a custom vocabulary for recognizing user utterances.
Possible values include:"UseSlotValuesAsCustomVocabulary"
parentSlotTypeSignature
— (String
)The new built-in slot type that should be used as the parent of this slot type.
botId
— (String
)The identifier of the bot that contains the slot type.
botVersion
— (String
)The version of the bot that contains the slot type. Must be
DRAFT
.localeId
— (String
)The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.
externalSourceSetting
— (map
)Provides information about the external source of the slot type's definition.
grammarSlotTypeSetting
— (map
)Settings required for a slot type based on a grammar that you provide.
source
— (map
)The source of the grammar used to create the slot type.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket that contains the grammar source.
s3ObjectKey
— required — (String
)The path to the grammar in the Amazon S3 bucket.
kmsKeyArn
— (String
)The KMS key required to decrypt the contents of the grammar, if any.
compositeSlotTypeSetting
— (map
)Specifications for a composite slot type.
subSlots
— (Array<map>
)Subslots in the composite slot.
name
— required — (String
)Name of a constituent sub slot inside a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:slotTypeId
— (String
)The unique identifier of the updated slot type.
slotTypeName
— (String
)The updated name of the slot type.
description
— (String
)The updated description of the slot type.
slotTypeValues
— (Array<map>
)The updated values that the slot type provides.
sampleValue
— (map
)The value of the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
synonyms
— (Array<map>
)Additional values related to the slot type entry.
value
— required — (String
)The value that can be used for a slot type.
valueSelectionSetting
— (map
)The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
resolutionStrategy
— required — (String
)Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
Possible values include:valueSelectionStrategy
, the default isORIGINAL_VALUE
."OriginalValue"
"TopResolution"
"Concatenation"
-
regexFilter
— (map
)A regular expression used to validate the value of a slot.
pattern
— required — (String
)A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or
{x,}
with no upper bound. -
Wild card (.)
-
advancedRecognitionSetting
— (map
)Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
audioRecognitionStrategy
— (String
)Enables using the slot values as a custom vocabulary for recognizing user utterances.
Possible values include:"UseSlotValuesAsCustomVocabulary"
parentSlotTypeSignature
— (String
)The updated signature of the built-in slot type that is the parent of this slot type.
botId
— (String
)The identifier of the bot that contains the slot type.
botVersion
— (String
)The version of the bot that contains the slot type. This is always
DRAFT
.localeId
— (String
)The language and locale of the updated slot type.
creationDateTime
— (Date
)The timestamp of the date and time that the slot type was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the slot type was last updated.
externalSourceSetting
— (map
)Provides information about the external source of the slot type's definition.
grammarSlotTypeSetting
— (map
)Settings required for a slot type based on a grammar that you provide.
source
— (map
)The source of the grammar used to create the slot type.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket that contains the grammar source.
s3ObjectKey
— required — (String
)The path to the grammar in the Amazon S3 bucket.
kmsKeyArn
— (String
)The KMS key required to decrypt the contents of the grammar, if any.
compositeSlotTypeSetting
— (map
)Specifications for a composite slot type.
subSlots
— (Array<map>
)Subslots in the composite slot.
name
— required — (String
)Name of a constituent sub slot inside a composite slot.
slotTypeId
— required — (String
)The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
-
(AWS.Response)
—
Returns:
updateTestSet(params = {}, callback) ⇒ AWS.Request
The action to update the test set.
Service Reference:
Examples:
Calling the updateTestSet operation
var params = { testSetId: 'STRING_VALUE', /* required */ testSetName: 'STRING_VALUE', /* required */ description: 'STRING_VALUE' }; lexmodelsv2.updateTestSet(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
testSetId
— (String
)The test set Id for which update test operation to be performed.
testSetName
— (String
)The new test set name.
description
— (String
)The new test set description.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:testSetId
— (String
)The test set Id for which update test operation to be performed.
testSetName
— (String
)The test set name for the updated test set.
description
— (String
)The test set description for the updated test set.
modality
— (String
)Indicates whether audio or text is used for the updated test set.
Possible values include:"Text"
"Audio"
status
— (String
)The status for the updated test set.
Possible values include:"Importing"
"PendingAnnotation"
"Deleting"
"ValidationError"
"Ready"
roleArn
— (String
)The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
numTurns
— (Integer
)The number of conversation turns from the updated test set.
storageLocation
— (map
)The Amazon S3 storage location for the updated test set.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
creationDateTime
— (Date
)The creation date and time for the updated test set.
lastUpdatedDateTime
— (Date
)The date and time of the last update for the updated test set.
-
(AWS.Response)
—
Returns:
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given LexModelsV2 resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.
Examples:
Waiting for the botAvailable state
var params = { botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botAvailable', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
state
(String)
—
the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.
-
params
(map)
(defaults to: {})
—
a list of parameters for the given state. See each waiter resource state for required parameters.
Callback (callback):
-
function(err, data) { ... }
Callback containing error and data information. See the respective resource state for the expected error or data information.
If the waiter times out its requests, it will return a
ResourceNotReady
error.
Returns:
Waiter Resource States:
Waiter Resource Details
lexmodelsv2.waitFor('botAvailable', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botAvailable
state by periodically calling the underlying LexModelsV2.describeBot() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botAvailable state
var params = { botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botAvailable', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botId
— (String
)The unique identifier of the bot to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The unique identifier of the bot.
botName
— (String
)The name of the bot.
description
— (String
)The description of the bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
dataPrivacy
— (map
)Settings for managing data privacy of the bot and its conversations with users.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
botStatus
— (String
)The current status of the bot. When the status is
Possible values include:Available
the bot is ready to be used in conversations with users."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
creationDateTime
— (Date
)A timestamp of the date and time that the bot was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the bot was last updated.
botType
— (String
)The type of the bot that was described.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The list of bots in the network that was described.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
failureReasons
— (Array<String>
)If the
botStatus
isFailed
, this contains a list of reasons that the bot couldn't be built.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botAliasAvailable', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botAliasAvailable
state by periodically calling the underlying LexModelsV2.describeBotAlias() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botAliasAvailable state
var params = { botAliasId: 'STRING_VALUE', /* required */ botId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botAliasAvailable', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botAliasId
— (String
)The identifier of the bot alias to describe.
botId
— (String
)The identifier of the bot associated with the bot alias to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botAliasId
— (String
)The identifier of the bot alias.
botAliasName
— (String
)The name of the bot alias.
description
— (String
)The description of the bot alias.
botVersion
— (String
)The version of the bot associated with the bot alias.
botAliasLocaleSettings
— (map<map>
)The locale settings that are unique to the alias.
enabled
— required — (Boolean
)Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.codeHookSpecification
— (map
)Specifies the Lambda function that should be used in the locale.
lambdaCodeHook
— required — (map
)Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
lambdaARN
— required — (String
)The Amazon Resource Name (ARN) of the Lambda function.
codeHookInterfaceVersion
— required — (String
)The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
conversationLogSettings
— (map
)Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
textLogSettings
— (Array<map>
)The Amazon CloudWatch Logs settings for logging text and metadata.
enabled
— required — (Boolean
)Determines whether conversation logs should be stored for an alias.
destination
— required — (map
)Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
cloudWatch
— required — (map
)Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
cloudWatchLogGroupArn
— required — (String
)The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
logPrefix
— required — (String
)The prefix of the log stream name within the log group that you specified
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for text.
audioLogSettings
— (Array<map>
)The Amazon S3 settings for logging audio to an S3 bucket.
enabled
— required — (Boolean
)Determines whether audio logging in enabled for the bot.
destination
— required — (map
)The location of audio log files collected when conversation logging is enabled for a bot.
s3Bucket
— required — (map
)The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
s3BucketArn
— required — (String
)The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
logPrefix
— required — (String
)The S3 prefix to assign to audio log files.
selectiveLoggingEnabled
— (Boolean
)The option to enable selective conversation log capture for audio.
sentimentAnalysisSettings
— (map
)Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
detectSentiment
— required — (Boolean
)Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
botAliasHistoryEvents
— (Array<map>
)A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
botVersion
— (String
)The version of the bot that was used in the event.
startDate
— (Date
)The date and time that the event started.
endDate
— (Date
)The date and time that the event ended.
botAliasStatus
— (String
)The current status of the alias. When the alias is
Possible values include:Available
, the alias is ready for use with your bot."Creating"
"Available"
"Deleting"
"Failed"
botId
— (String
)The identifier of the bot associated with the bot alias.
creationDateTime
— (Date
)A timestamp of the date and time that the alias was created.
lastUpdatedDateTime
— (Date
)A timestamp of the date and time that the alias was last updated.
parentBotNetworks
— (Array<map>
)A list of the networks to which the bot alias you described belongs.
botId
— required — (String
)The identifier of the network of bots assigned by Amazon Lex.
botVersion
— required — (String
)The version of the network of bots.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botExportCompleted', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botExportCompleted
state by periodically calling the underlying LexModelsV2.describeExport() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botExportCompleted state
var params = { exportId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botExportCompleted', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
exportId
— (String
)The unique identifier of the export to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:exportId
— (String
)The unique identifier of the described export.
resourceSpecification
— (map
)The bot, bot ID, and optional locale ID of the exported bot or bot locale.
botExportSpecification
— (map
)Parameters for exporting a bot.
botId
— required — (String
)The identifier of the bot assigned by Amazon Lex.
botVersion
— required — (String
)The version of the bot that was exported. This will be either
DRAFT
or the version number.
botLocaleExportSpecification
— (map
)Parameters for exporting a bot locale.
botId
— required — (String
)The identifier of the bot to create the locale for.
botVersion
— required — (String
)The version of the bot to export.
localeId
— required — (String
)The identifier of the language and locale to export. The string must match one of the locales in the bot.
customVocabularyExportSpecification
— (map
)The parameters required to export a custom vocabulary.
botId
— required — (String
)The identifier of the bot that contains the custom vocabulary to export.
botVersion
— required — (String
)The version of the bot that contains the custom vocabulary to export.
localeId
— required — (String
)The locale of the bot that contains the custom vocabulary to export.
testSetExportSpecification
— (map
)Specifications for the test set that is exported as a resource.
testSetId
— required — (String
)The unique identifier of the test set.
fileFormat
— (String
)The file format used in the files that describe the resource.
Possible values include:"LexJson"
"TSV"
"CSV"
exportStatus
— (String
)The status of the export. When the status is
Possible values include:Complete
the export archive file is available for download."InProgress"
"Completed"
"Failed"
"Deleting"
failureReasons
— (Array<String>
)If the
exportStatus
is failed, contains one or more reasons why the export could not be completed.downloadUrl
— (String
)A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the
DescribeExport
operation.creationDateTime
— (Date
)The date and time that the export was created.
lastUpdatedDateTime
— (Date
)The last date and time that the export was updated.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botImportCompleted', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botImportCompleted
state by periodically calling the underlying LexModelsV2.describeImport() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botImportCompleted state
var params = { importId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botImportCompleted', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
importId
— (String
)The unique identifier of the import to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:importId
— (String
)The unique identifier of the described import.
resourceSpecification
— (map
)The specifications of the imported bot, bot locale, or custom vocabulary.
botImportSpecification
— (map
)Parameters for importing a bot.
botName
— required — (String
)The name that Amazon Lex should use for the bot.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy
— required — (map
)By default, data stored by Amazon Lex is encrypted. The
DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags
— (map<String>
)A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation.testBotAliasTags
— (map<String>
)A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
botLocaleImportSpecification
— (map
)Parameters for importing a bot locale.
botId
— required — (String
)The identifier of the bot to import the locale to.
botVersion
— required — (String
)The version of the bot to import the locale to. This can only be the
DRAFT
version of the bot.localeId
— required — (String
)The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold
— (Float
)Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voiceSettings
— (map
)Defines settings for using an Amazon Polly voice to communicate with a user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
customVocabularyImportSpecification
— (map
)Provides the parameters required for importing a custom vocabulary.
botId
— required — (String
)The identifier of the bot to import the custom vocabulary to.
botVersion
— required — (String
)The version of the bot to import the custom vocabulary to.
localeId
— required — (String
)The identifier of the local to import the custom vocabulary to. The value must be
en_GB
.
testSetImportResourceSpecification
— (map
)Specifications for the test set that is imported.
testSetName
— required — (String
)The name of the test set.
description
— (String
)The description of the test set.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation
— required — (map
)Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket in which the test set is stored.
s3Path
— required — (String
)The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation
— required — (map
)Contains information about the input location from where test-set should be imported.
s3BucketName
— required — (String
)The name of the Amazon S3 bucket.
s3Path
— required — (String
)The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality
— required — (String
)Specifies whether the test-set being imported contains written or spoken data.
Possible values include:"Text"
"Audio"
testSetTags
— (map<String>
)A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
importedResourceId
— (String
)The unique identifier that Amazon Lex assigned to the resource created by the import.
importedResourceName
— (String
)The name of the imported resource.
mergeStrategy
— (String
)The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
Possible values include:FailOnConflict
existing resources are not overwritten and the import fails."Overwrite"
"FailOnConflict"
"Append"
importStatus
— (String
)The status of the import process. When the status is
Possible values include:Completed
the resource is imported and ready for use."InProgress"
"Completed"
"Failed"
"Deleting"
failureReasons
— (Array<String>
)If the
importStatus
field isFailed
, this provides one or more reasons for the failure.creationDateTime
— (Date
)The date and time that the import was created.
lastUpdatedDateTime
— (Date
)The date and time that the import was last updated.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botLocaleBuilt', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botLocaleBuilt
state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botLocaleBuilt state
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botLocaleBuilt', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the described locale.
localeName
— (String
)The name of the locale.
description
— (String
)The description of the locale.
nluIntentConfidenceThreshold
— (Float
)The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
intentsCount
— (Integer
)The number of intents defined for the locale.
slotTypesCount
— (Integer
)The number of slot types defined for the locale.
botLocaleStatus
— (String
)The status of the bot. If the status is
Possible values include:Failed
, the reasons for the failure are listed in thefailureReasons
field."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
failureReasons
— (Array<String>
)if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.creationDateTime
— (Date
)The date and time that the locale was created.
lastUpdatedDateTime
— (Date
)The date and time that the locale was last updated.
lastBuildSubmittedDateTime
— (Date
)The date and time that the locale was last submitted for building.
botLocaleHistoryEvents
— (Array<map>
)History of changes, such as when a locale is used in an alias, that have taken place for the locale.
event
— required — (String
)A description of the event that occurred.
eventDate
— required — (Date
)A timestamp of the date and time that the event occurred.
recommendedActions
— (Array<String>
)Recommended actions to take to resolve an error in the
failureReasons
field.generativeAISettings
— (map
)Contains settings for Amazon Bedrock's generative AI features for your bot locale.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botLocaleExpressTestingAvailable', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botLocaleExpressTestingAvailable
state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botLocaleExpressTestingAvailable state
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botLocaleExpressTestingAvailable', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the described locale.
localeName
— (String
)The name of the locale.
description
— (String
)The description of the locale.
nluIntentConfidenceThreshold
— (Float
)The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
intentsCount
— (Integer
)The number of intents defined for the locale.
slotTypesCount
— (Integer
)The number of slot types defined for the locale.
botLocaleStatus
— (String
)The status of the bot. If the status is
Possible values include:Failed
, the reasons for the failure are listed in thefailureReasons
field."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
failureReasons
— (Array<String>
)if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.creationDateTime
— (Date
)The date and time that the locale was created.
lastUpdatedDateTime
— (Date
)The date and time that the locale was last updated.
lastBuildSubmittedDateTime
— (Date
)The date and time that the locale was last submitted for building.
botLocaleHistoryEvents
— (Array<map>
)History of changes, such as when a locale is used in an alias, that have taken place for the locale.
event
— required — (String
)A description of the event that occurred.
eventDate
— required — (Date
)A timestamp of the date and time that the event occurred.
recommendedActions
— (Array<String>
)Recommended actions to take to resolve an error in the
failureReasons
field.generativeAISettings
— (map
)Contains settings for Amazon Bedrock's generative AI features for your bot locale.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botVersionAvailable', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botVersionAvailable
state by periodically calling the underlying LexModelsV2.describeBotVersion() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botVersionAvailable state
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botVersionAvailable', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botId
— (String
)The identifier of the bot containing the version to return metadata for.
botVersion
— (String
)The version of the bot to return metadata for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot that contains the version.
botName
— (String
)The name of the bot that contains the version.
botVersion
— (String
)The version of the bot that was described.
description
— (String
)The description specified for the bot.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
dataPrivacy
— (map
)Data privacy settings for the bot version.
childDirected
— required — (Boolean
)For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds
— (Integer
)The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
botStatus
— (String
)The current status of the bot. When the status is
Possible values include:Available
, the bot version is ready for use."Creating"
"Available"
"Inactive"
"Deleting"
"Failed"
"Versioning"
"Importing"
"Updating"
failureReasons
— (Array<String>
)If the
botStatus
isFailed
, this contains a list of reasons that the version couldn't be built.creationDateTime
— (Date
)A timestamp of the date and time that the bot version was created.
parentBotNetworks
— (Array<map>
)A list of the networks to which the bot version you described belongs.
botId
— required — (String
)The identifier of the network of bots assigned by Amazon Lex.
botVersion
— required — (String
)The version of the network of bots.
botType
— (String
)The type of the bot in the version that was described.
Possible values include:"Bot"
"BotNetwork"
botMembers
— (Array<map>
)The members of bot network in the version that was described.
botMemberId
— required — (String
)The unique ID of a bot that is a member of this network of bots.
botMemberName
— required — (String
)The unique name of a bot that is a member of this network of bots.
botMemberAliasId
— required — (String
)The alias ID of a bot that is a member of this network of bots.
botMemberAliasName
— required — (String
)The alias name of a bot that is a member of this network of bots.
botMemberVersion
— required — (String
)The version of a bot that is a member of this network of bots.
-
(AWS.Response)
—
Returns:
See Also:
lexmodelsv2.waitFor('botLocaleCreated', params = {}, [callback]) ⇒ AWS.Request
Waits for the
botLocaleCreated
state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).Examples:
Waiting for the botLocaleCreated state
var params = { botId: 'STRING_VALUE', /* required */ botVersion: 'STRING_VALUE', /* required */ localeId: 'STRING_VALUE' /* required */ }; lexmodelsv2.waitFor('botLocaleCreated', params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
—
botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:botId
— (String
)The identifier of the bot associated with the locale.
botVersion
— (String
)The version of the bot associated with the locale.
localeId
— (String
)The unique identifier of the described locale.
localeName
— (String
)The name of the locale.
description
— (String
)The description of the locale.
nluIntentConfidenceThreshold
— (Float
)The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.voiceSettings
— (map
)The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
voiceId
— required — (String
)The identifier of the Amazon Polly voice to use.
engine
— (String
)Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
Possible values include:standard
."standard"
"neural"
intentsCount
— (Integer
)The number of intents defined for the locale.
slotTypesCount
— (Integer
)The number of slot types defined for the locale.
botLocaleStatus
— (String
)The status of the bot. If the status is
Possible values include:Failed
, the reasons for the failure are listed in thefailureReasons
field."Creating"
"Building"
"Built"
"ReadyExpressTesting"
"Failed"
"Deleting"
"NotBuilt"
"Importing"
"Processing"
failureReasons
— (Array<String>
)if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.creationDateTime
— (Date
)The date and time that the locale was created.
lastUpdatedDateTime
— (Date
)The date and time that the locale was last updated.
lastBuildSubmittedDateTime
— (Date
)The date and time that the locale was last submitted for building.
botLocaleHistoryEvents
— (Array<map>
)History of changes, such as when a locale is used in an alias, that have taken place for the locale.
event
— required — (String
)A description of the event that occurred.
eventDate
— required — (Date
)A timestamp of the date and time that the event occurred.
recommendedActions
— (Array<String>
)Recommended actions to take to resolve an error in the
failureReasons
field.generativeAISettings
— (map
)Contains settings for Amazon Bedrock's generative AI features for your bot locale.
runtimeSettings
— (map
)Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement
— (map
)An object containing specifications for the assisted slot resolution feature.
enabled
— required — (Boolean
)Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
buildtimeSettings
— (map
)Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder
— (map
)An object containing specifications for the descriptive bot building feature.
enabled
— required — (Boolean
)Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification
— (map
)An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration
— (map
)Contains specifications for the sample utterance generation feature.
enabled
— required — (Boolean
)Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification
— (map
)Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn
— required — (String
)The ARN of the foundation model used in descriptive bot building.
guardrail
— (map
)The guardrail configuration in the Bedrock model specification details.
identifier
— required — (String
)The unique guardrail id for the Bedrock guardrail configuration.
version
— required — (String
)The guardrail version for the Bedrock guardrail configuration.
traceStatus
— (String
)The Bedrock trace status in the Bedrock model specification details.
Possible values include:"ENABLED"
"DISABLED"
customPrompt
— (String
)The custom prompt used in the Bedrock model specification details.
-
(AWS.Response)
—
Returns:
See Also:
Generated on Thu Aug 15 19:12:39 2024 by yard 0.9.36 (ruby-2.3.1). - listUtteranceMetrics(params = {}, callback) ⇒ AWS.Request