SDK for PHP 3.x

Amazon Lex Runtime Service 2016-11-28

Client: Aws\LexRuntimeService\LexRuntimeServiceClient
Service ID: runtime.lex
Version: 2016-11-28

This page describes the parameters and results for the operations of the Amazon Lex Runtime Service (2016-11-28), and shows how to use the Aws\LexRuntimeService\LexRuntimeServiceClient object to call the described operations. This documentation is specific to the 2016-11-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteSession ( array $params = [] )
Removes session information for a specified bot, alias, and user ID.
GetSession ( array $params = [] )
Returns session information for a specified bot, alias, and user ID.
PostContent ( array $params = [] )
Sends user input (text or speech) to Amazon Lex.
PostText ( array $params = [] )
Sends user input to Amazon Lex.
PutSession ( array $params = [] )
Creates a new session or modifies an existing session with an Amazon Lex bot.

Operations

DeleteSession 

$result = $client->deleteSession([/* ... */]);
$promise = $client->deleteSessionAsync([/* ... */]);

Removes session information for a specified bot, alias, and user ID.

Parameter Syntax

$result = $client->deleteSession([
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botAlias
Required: Yes
Type: string

The alias in use for the bot that contains the session data.

botName
Required: Yes
Type: string

The name of the bot that contains the session data.

userId
Required: Yes
Type: string

The identifier of the user associated with the session data.

Result Syntax

[
    'botAlias' => '<string>',
    'botName' => '<string>',
    'sessionId' => '<string>',
    'userId' => '<string>',
]

Result Details

Members
botAlias
Type: string

The alias in use for the bot associated with the session data.

botName
Type: string

The name of the bot associated with the session data.

sessionId
Type: string

The unique identifier for the session.

userId
Type: string

The ID of the client application user.

Errors

NotFoundException:

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

BadRequestException:

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

LimitExceededException:

Exceeded a limit.

InternalFailureException:

Internal service error. Retry the call.

ConflictException:

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

GetSession 

$result = $client->getSession([/* ... */]);
$promise = $client->getSessionAsync([/* ... */]);

Returns session information for a specified bot, alias, and user ID.

Parameter Syntax

$result = $client->getSession([
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'checkpointLabelFilter' => '<string>',
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botAlias
Required: Yes
Type: string

The alias in use for the bot that contains the session data.

botName
Required: Yes
Type: string

The name of the bot that contains the session data.

checkpointLabelFilter
Type: string

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

userId
Required: Yes
Type: string

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Result Syntax

[
    'activeContexts' => [
        [
            'name' => '<string>',
            'parameters' => ['<string>', ...],
            'timeToLive' => [
                'timeToLiveInSeconds' => <integer>,
                'turnsToLive' => <integer>,
            ],
        ],
        // ...
    ],
    'dialogAction' => [
        'fulfillmentState' => 'Fulfilled|Failed|ReadyForFulfillment',
        'intentName' => '<string>',
        'message' => '<string>',
        'messageFormat' => 'PlainText|CustomPayload|SSML|Composite',
        'slotToElicit' => '<string>',
        'slots' => ['<string>', ...],
        'type' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Close|Delegate',
    ],
    'recentIntentSummaryView' => [
        [
            'checkpointLabel' => '<string>',
            'confirmationStatus' => 'None|Confirmed|Denied',
            'dialogActionType' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Close|Delegate',
            'fulfillmentState' => 'Fulfilled|Failed|ReadyForFulfillment',
            'intentName' => '<string>',
            'slotToElicit' => '<string>',
            'slots' => ['<string>', ...],
        ],
        // ...
    ],
    'sessionAttributes' => ['<string>', ...],
    'sessionId' => '<string>',
]

Result Details

Members
activeContexts
Type: Array of ActiveContext structures

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.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

dialogAction
Type: DialogAction structure

Describes the current state of the bot.

recentIntentSummaryView
Type: Array of IntentSummary structures

An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

sessionAttributes
Type: Associative array of custom strings keys (String) to strings

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

sessionId
Type: string

A unique identifier for the session.

Errors

NotFoundException:

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

BadRequestException:

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

LimitExceededException:

Exceeded a limit.

InternalFailureException:

Internal service error. Retry the call.

PostContent 

$result = $client->postContent([/* ... */]);
$promise = $client->postContentAsync([/* ... */]);

Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.

The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.

In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:

  • For a user input "I would like a pizza," Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?".

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: "Order the pizza?".

  • After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".

Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • x-amz-lex-dialog-state header set to ElicitSlot

    • x-amz-lex-intent-name header set to the intent name in the current context

    • x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information

    • x-amz-lex-slots header set to a map of slots configured for the intent with their current values

  • If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted.

  • If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.

In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.

Parameter Syntax

$result = $client->postContent([
    'accept' => '<string>',
    'activeContexts' => '<string>',
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'contentType' => '<string>', // REQUIRED
    'inputStream' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'requestAttributes' => '<string>',
    'sessionAttributes' => '<string>',
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Members
accept
Type: string

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

  • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

  • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/* (defaults to mpeg)

activeContexts
Type: string (string|number|array|map or anything parsable by json_encode)

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias
Required: Yes
Type: string

Alias of the Amazon Lex bot.

botName
Required: Yes
Type: string

Name of the Amazon Lex bot.

contentType
Required: Yes
Type: string

You pass this value as the Content-Type HTTP header.

Indicates the audio format or text. The header value must start with one of the following prefixes:

  • 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

inputStream
Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.

You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.

requestAttributes
Type: string (string|number|array|map or anything parsable by json_encode)

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

sessionAttributes
Type: string (string|number|array|map or anything parsable by json_encode)

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

userId
Required: Yes
Type: string

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Result Syntax

[
    'activeContexts' => '<string>',
    'alternativeIntents' => '<string>',
    'audioStream' => <string || resource || Psr\Http\Message\StreamInterface>,
    'botVersion' => '<string>',
    'contentType' => '<string>',
    'dialogState' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Fulfilled|ReadyForFulfillment|Failed',
    'encodedInputTranscript' => '<string>',
    'encodedMessage' => '<string>',
    'inputTranscript' => '<string>',
    'intentName' => '<string>',
    'message' => '<string>',
    'messageFormat' => 'PlainText|CustomPayload|SSML|Composite',
    'nluIntentConfidence' => '<string>',
    'sentimentResponse' => '<string>',
    'sessionAttributes' => '<string>',
    'sessionId' => '<string>',
    'slotToElicit' => '<string>',
    'slots' => '<string>',
]

Result Details

Members
activeContexts
Type: string (string|number|array|map or anything parsable by json_encode)

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.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

alternativeIntents
Type: string (string|number|array|map or anything parsable by json_encode)

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

Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

audioStream
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

botVersion
Type: string

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.

contentType
Type: string

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

dialogState
Type: string

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.

  • ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:

    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.

  • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

    For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).

  • ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

  • Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the request.

  • Failed - Conveys that the conversation with the user failed.

    This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.

encodedInputTranscript
Type: string

The text used to process the request.

If the input was an audio stream, the encodedInputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

The encodedInputTranscript field is base-64 encoded. You must decode the field before you can use the value.

encodedMessage
Type: string

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

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

inputTranscript
Type: string

The text used to process the request.

You can use this field only 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 inputTranscript field is null. You should use the encodedInputTranscript field instead.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

intentName
Type: string

Current user intent that Amazon Lex is aware of.

message
Type: string

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.

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

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

messageFormat
Type: string

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

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

nluIntentConfidence
Type: string (string|number|array|map or anything parsable by json_encode)

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.

The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

sentimentResponse
Type: string

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

sessionAttributes
Type: string (string|number|array|map or anything parsable by json_encode)

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

sessionId
Type: string

The unique identifier for the session.

slotToElicit
Type: string

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

slots
Type: string (string|number|array|map or anything parsable by json_encode)

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.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

Errors

NotFoundException:

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

BadRequestException:

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

LimitExceededException:

Exceeded a limit.

InternalFailureException:

Internal service error. Retry the call.

ConflictException:

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

UnsupportedMediaTypeException:

The Content-Type header (PostContent API) has an invalid value.

NotAcceptableException:

The accept header in the request does not have a valid value.

RequestTimeoutException:

The input speech is too long.

DependencyFailedException:

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

  • If Amazon Lex does not have sufficient permissions to call a Lambda function.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

BadGatewayException:

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

LoopDetectedException:

This exception is not used.

PostText 

$result = $client->postText([/* ... */]);
$promise = $client->postTextAsync([/* ... */]);

Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.

In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:

  • For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".

  • After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".

Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a "yes" or "no" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • dialogState set to ElicitSlot

    • intentName set to the intent name in the current context

    • slotToElicit set to the slot name for which the message is eliciting information

    • slots set to a map of slots, configured for the intent, with currently known values

  • If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.

  • If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.

In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.

Parameter Syntax

$result = $client->postText([
    'activeContexts' => [
        [
            'name' => '<string>', // REQUIRED
            'parameters' => ['<string>', ...], // REQUIRED
            'timeToLive' => [ // REQUIRED
                'timeToLiveInSeconds' => <integer>,
                'turnsToLive' => <integer>,
            ],
        ],
        // ...
    ],
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'inputText' => '<string>', // REQUIRED
    'requestAttributes' => ['<string>', ...],
    'sessionAttributes' => ['<string>', ...],
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Members
activeContexts
Type: Array of ActiveContext structures

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias
Required: Yes
Type: string

The alias of the Amazon Lex bot.

botName
Required: Yes
Type: string

The name of the Amazon Lex bot.

inputText
Required: Yes
Type: string

The text that the user entered (Amazon Lex interprets this text).

requestAttributes
Type: Associative array of custom strings keys (String) to strings

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

sessionAttributes
Type: Associative array of custom strings keys (String) to strings

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

userId
Required: Yes
Type: string

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Result Syntax

[
    'activeContexts' => [
        [
            'name' => '<string>',
            'parameters' => ['<string>', ...],
            'timeToLive' => [
                'timeToLiveInSeconds' => <integer>,
                'turnsToLive' => <integer>,
            ],
        ],
        // ...
    ],
    'alternativeIntents' => [
        [
            'intentName' => '<string>',
            'nluIntentConfidence' => [
                'score' => <float>,
            ],
            'slots' => ['<string>', ...],
        ],
        // ...
    ],
    'botVersion' => '<string>',
    'dialogState' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Fulfilled|ReadyForFulfillment|Failed',
    'intentName' => '<string>',
    'message' => '<string>',
    'messageFormat' => 'PlainText|CustomPayload|SSML|Composite',
    'nluIntentConfidence' => [
        'score' => <float>,
    ],
    'responseCard' => [
        'contentType' => 'application/vnd.amazonaws.card.generic',
        'genericAttachments' => [
            [
                'attachmentLinkUrl' => '<string>',
                'buttons' => [
                    [
                        'text' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'imageUrl' => '<string>',
                'subTitle' => '<string>',
                'title' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
    'sentimentResponse' => [
        'sentimentLabel' => '<string>',
        'sentimentScore' => '<string>',
    ],
    'sessionAttributes' => ['<string>', ...],
    'sessionId' => '<string>',
    'slotToElicit' => '<string>',
    'slots' => ['<string>', ...],
]

Result Details

Members
activeContexts
Type: Array of ActiveContext structures

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.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

alternativeIntents
Type: Array of PredictedIntent structures

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

Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

botVersion
Type: string

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.

dialogState
Type: string

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.

  • ElicitIntent - Amazon Lex wants to elicit user intent.

    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

  • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

    For example, Amazon Lex wants user confirmation before fulfilling an intent.

    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

  • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

  • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

  • Failed - Conveys that the conversation with the user failed.

    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

intentName
Type: string

The current user intent that Amazon Lex is aware of.

message
Type: string

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

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

messageFormat
Type: string

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

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format defined by the Lambda function.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

nluIntentConfidence
Type: IntentConfidence structure

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. For more information, see Confidence Scores.

The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

responseCard
Type: ResponseCard structure

Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).

sentimentResponse
Type: SentimentResponse structure

The sentiment expressed in and utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

sessionAttributes
Type: Associative array of custom strings keys (String) to strings

A map of key-value pairs representing the session-specific context information.

sessionId
Type: string

A unique identifier for the session.

slotToElicit
Type: string

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

slots
Type: Associative array of custom strings keys (String) to strings

The intent slots that Amazon Lex detected from the user input in the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

Errors

NotFoundException:

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

BadRequestException:

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

LimitExceededException:

Exceeded a limit.

InternalFailureException:

Internal service error. Retry the call.

ConflictException:

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

DependencyFailedException:

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

  • If Amazon Lex does not have sufficient permissions to call a Lambda function.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

BadGatewayException:

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

LoopDetectedException:

This exception is not used.

PutSession 

$result = $client->putSession([/* ... */]);
$promise = $client->putSessionAsync([/* ... */]);

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.

For more information, see Managing Sessions.

Parameter Syntax

$result = $client->putSession([
    'accept' => '<string>',
    'activeContexts' => [
        [
            'name' => '<string>', // REQUIRED
            'parameters' => ['<string>', ...], // REQUIRED
            'timeToLive' => [ // REQUIRED
                'timeToLiveInSeconds' => <integer>,
                'turnsToLive' => <integer>,
            ],
        ],
        // ...
    ],
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'dialogAction' => [
        'fulfillmentState' => 'Fulfilled|Failed|ReadyForFulfillment',
        'intentName' => '<string>',
        'message' => '<string>',
        'messageFormat' => 'PlainText|CustomPayload|SSML|Composite',
        'slotToElicit' => '<string>',
        'slots' => ['<string>', ...],
        'type' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Close|Delegate', // REQUIRED
    ],
    'recentIntentSummaryView' => [
        [
            'checkpointLabel' => '<string>',
            'confirmationStatus' => 'None|Confirmed|Denied',
            'dialogActionType' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Close|Delegate', // REQUIRED
            'fulfillmentState' => 'Fulfilled|Failed|ReadyForFulfillment',
            'intentName' => '<string>',
            'slotToElicit' => '<string>',
            'slots' => ['<string>', ...],
        ],
        // ...
    ],
    'sessionAttributes' => ['<string>', ...],
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Members
accept
Type: string

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

  • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

  • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

  • If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • audio/* (defaults to mpeg)

    • text/plain; charset=utf-8

activeContexts
Type: Array of ActiveContext structures

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias
Required: Yes
Type: string

The alias in use for the bot that contains the session data.

botName
Required: Yes
Type: string

The name of the bot that contains the session data.

dialogAction
Type: DialogAction structure

Sets the next action that the bot should take to fulfill the conversation.

recentIntentSummaryView
Type: Array of IntentSummary structures

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

  • intentName

  • slot names

  • slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

sessionAttributes
Type: Associative array of custom strings keys (String) to strings

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

userId
Required: Yes
Type: string

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Result Syntax

[
    'activeContexts' => '<string>',
    'audioStream' => <string || resource || Psr\Http\Message\StreamInterface>,
    'contentType' => '<string>',
    'dialogState' => 'ElicitIntent|ConfirmIntent|ElicitSlot|Fulfilled|ReadyForFulfillment|Failed',
    'encodedMessage' => '<string>',
    'intentName' => '<string>',
    'message' => '<string>',
    'messageFormat' => 'PlainText|CustomPayload|SSML|Composite',
    'sessionAttributes' => '<string>',
    'sessionId' => '<string>',
    'slotToElicit' => '<string>',
    'slots' => '<string>',
]

Result Details

Members
activeContexts
Type: string (string|number|array|map or anything parsable by json_encode)

A list of active contexts for the session.

audioStream
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The audio version of the message to convey to the user.

contentType
Type: string

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

dialogState
Type: string

  • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

  • ElicitIntent - Amazon Lex wants to elicit the user's intent.

  • ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

  • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

encodedMessage
Type: string

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

intentName
Type: string

The name of the current intent.

message
Type: string

The next message that should be presented to the user.

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.

messageFormat
Type: string

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

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

sessionAttributes
Type: string (string|number|array|map or anything parsable by json_encode)

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

sessionId
Type: string

A unique identifier for the session.

slotToElicit
Type: string

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

slots
Type: string (string|number|array|map or anything parsable by json_encode)

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

Errors

NotFoundException:

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

BadRequestException:

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

LimitExceededException:

Exceeded a limit.

InternalFailureException:

Internal service error. Retry the call.

ConflictException:

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

NotAcceptableException:

The accept header in the request does not have a valid value.

DependencyFailedException:

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

  • If Amazon Lex does not have sufficient permissions to call a Lambda function.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

BadGatewayException:

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

Shapes

ActiveContext

Description

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

Members
name
Required: Yes
Type: string

The name of the context.

parameters
Required: Yes
Type: Associative array of custom strings keys (ParameterName) to strings

State variables for the current context. You can use these values as default values for slots in subsequent events.

timeToLive
Required: Yes
Type: ActiveContextTimeToLive structure

The length of time or number of turns that a context remains active.

ActiveContextTimeToLive

Description

The length of time or number of turns that a context remains active.

Members
timeToLiveInSeconds
Type: int

The number of seconds that the context should be active after it is first sent in a PostContent or PostText response. You can set the value between 5 and 86,400 seconds (24 hours).

turnsToLive
Type: int

The number of conversation turns that the context should be active. A conversation turn is one PostContent or PostText request and the corresponding response from Amazon Lex.

BadGatewayException

Description

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

Members
Message
Type: string

BadRequestException

Description

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

Members
message
Type: string

Button

Description

Represents an option to be shown on the client platform (Facebook, Slack, etc.)

Members
text
Required: Yes
Type: string

Text that is visible to the user on the button.

value
Required: Yes
Type: string

The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City."

ConflictException

Description

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

Members
message
Type: string

DependencyFailedException

Description

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

  • If Amazon Lex does not have sufficient permissions to call a Lambda function.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

Members
Message
Type: string

DialogAction

Description

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

Members
fulfillmentState
Type: string

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

intentName
Type: string

The name of the intent.

message
Type: string

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

messageFormat
Type: string

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

slotToElicit
Type: string

The name of the slot that should be elicited from the user.

slots
Type: Associative array of custom strings keys (String) to strings

Map of the slots that have been gathered and their values.

type
Required: Yes
Type: string

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

GenericAttachment

Description

Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.

Members
attachmentLinkUrl
Type: string

The URL of an attachment to the response card.

buttons
Type: Array of Button structures

The list of options to show to the user.

imageUrl
Type: string

The URL of an image that is displayed to the user.

subTitle
Type: string

The subtitle shown below the title.

title
Type: string

The title of the option.

IntentConfidence

Description

Provides a score that indicates the confidence that Amazon Lex has that an intent is the one that satisfies the user's intent.

Members
score
Type: double

A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

IntentSummary

Description

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

Members
checkpointLabel
Type: string

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

confirmationStatus
Type: string

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

  • Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

  • Denied - The user has responded "No" to the confirmation prompt.

  • None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

dialogActionType
Required: Yes
Type: string

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

fulfillmentState
Type: string

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

intentName
Type: string

The name of the intent.

slotToElicit
Type: string

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

slots
Type: Associative array of custom strings keys (String) to strings

Map of the slots that have been gathered and their values.

InternalFailureException

Description

Internal service error. Retry the call.

Members
message
Type: string

LimitExceededException

Description

Exceeded a limit.

Members
message
Type: string
retryAfterSeconds
Type: string

LoopDetectedException

Description

This exception is not used.

Members
Message
Type: string

NotAcceptableException

Description

The accept header in the request does not have a valid value.

Members
message
Type: string

NotFoundException

Description

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

Members
message
Type: string

PredictedIntent

Description

An intent that Amazon Lex suggests satisfies the user's intent. Includes the name of the intent, the confidence that Amazon Lex has that the user's intent is satisfied, and the slots defined for the intent.

Members
intentName
Type: string

The name of the intent that Amazon Lex suggests satisfies the user's intent.

nluIntentConfidence
Type: IntentConfidence structure

Indicates how confident Amazon Lex is that an intent satisfies the user's intent.

slots
Type: Associative array of custom strings keys (String) to strings

The slot and slot values associated with the predicted intent.

RequestTimeoutException

Description

The input speech is too long.

Members
message
Type: string

ResponseCard

Description

If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot values that are available, and then returns it. The response card can also come from a Lambda function ( dialogCodeHook and fulfillmentActivity on an intent).

Members
contentType
Type: string

The content type of the response.

genericAttachments
Type: Array of GenericAttachment structures

An array of attachment objects representing options.

version
Type: string

The version of the response card format.

SentimentResponse

Description

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field structure contains the result of the analysis.

Members
sentimentLabel
Type: string

The inferred sentiment that Amazon Comprehend has the highest confidence in.

sentimentScore
Type: string

The likelihood that the sentiment was correctly inferred.

UnsupportedMediaTypeException

Description

The Content-Type header (PostContent API) has an invalid value.

Members
message
Type: string