lexruntimeservice_post_text {paws.machine.learning}

Sends user input to Amazon Lex

Description

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.

See https://www.paws-r-sdk.com/docs/lexruntimeservice_post_text/ for full documentation.

Usage

lexruntimeservice_post_text(
  botName,
  botAlias,
  userId,
  sessionAttributes = NULL,
  requestAttributes = NULL,
  inputText,
  activeContexts = NULL
)

Arguments

botName

[required] The name of the Amazon Lex bot.

botAlias

[required] The alias of the Amazon Lex bot.

userId

[required] 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.

sessionAttributes

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

For more information, see Setting Session Attributes.

requestAttributes

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.

inputText

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

activeContexts

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.