class Aws::Lex::Types::PostTextRequest
@note When making an API call, you may pass PostTextRequest
data as a hash: { bot_name: "BotName", # required bot_alias: "BotAlias", # required user_id: "UserId", # required session_attributes: { "String" => "String", }, request_attributes: { "String" => "String", }, input_text: "Text", # required active_contexts: [ { name: "ActiveContextName", # required time_to_live: { # required time_to_live_in_seconds: 1, turns_to_live: 1, }, parameters: { # required "ParameterName" => "Text", }, }, ], }
@!attribute [rw] bot_name
The name of the Amazon Lex bot. @return [String]
@!attribute [rw] bot_alias
The alias of the Amazon Lex bot. @return [String]
@!attribute [rw] user_id
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. @return [String]
@!attribute [rw] session_attributes
Application-specific information passed between Amazon Lex and a client application. For more information, see [Setting Session Attributes][1]. [1]: https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs @return [Hash<String,String>]
@!attribute [rw] request_attributes
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][1]. [1]: https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs @return [Hash<String,String>]
@!attribute [rw] input_text
The text that the user entered (Amazon Lex interprets this text). @return [String]
@!attribute [rw] active_contexts
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. @return [Array<Types::ActiveContext>]
@see docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PostTextRequest AWS API Documentation
Constants
- SENSITIVE