Builder

class Builder

Properties

Link copied to clipboard

A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

Link copied to clipboard

One to four alternative intents that may be applicable to the user's intent.

Link copied to clipboard

The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.

Link copied to clipboard

The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.

Link copied to clipboard

Content type as specified in the Accept HTTP header in the request.

Link copied to clipboard

Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

Link copied to clipboard

The text used to process the request.

Link copied to clipboard

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

Link copied to clipboard

The text used to process the request.

Link copied to clipboard

Current user intent that Amazon Lex is aware of.

Link copied to clipboard

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

Link copied to clipboard

The format of the response message. One of the following values:

Link copied to clipboard

Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0.

Link copied to clipboard

The sentiment expressed in an utterance.

Link copied to clipboard

Map of key/value pairs representing the session-specific context information.

Link copied to clipboard

The unique identifier for the session.

Link copied to clipboard

Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.

Link copied to clipboard

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.