You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::LexRuntimeService::Types::PostTextRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb

Overview

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",
  },
  input_text: "Text", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#bot_aliasString

The alias of the Amazon Lex bot.

Returns:

  • (String)


455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb', line 455

class PostTextRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :input_text)
  include Aws::Structure
end

#bot_nameString

The name of the Amazon Lex bot.

Returns:

  • (String)


455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb', line 455

class PostTextRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :input_text)
  include Aws::Structure
end

#input_textString

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

Returns:

  • (String)


455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb', line 455

class PostTextRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :input_text)
  include Aws::Structure
end

#session_attributesHash<String,String>

By using session attributes, a client application can pass contextual information in the request to Amazon Lex For example,

  • In Getting Started Exercise 1, the example bot uses the price session attribute to maintain the price of the flowers ordered (for example, "Price":25). The code hook (the Lambda function) sets this attribute based on the type of flowers ordered. For more information, see Review the Details of Information Flow.

  • In the BookTrip bot exercise, the bot uses the currentReservation session attribute to maintain slot data during the in-progress conversation to book a hotel or book a car. For more information, see Details of Information Flow.

  • You might use the session attributes (key, value pairs) to track the requestID of user requests.

Amazon Lex simply passes these session attributes to the Lambda functions configured for the intent.

In your Lambda function, you can also use the session attributes for initialization and customization (prompts and response cards). Some examples are:

  • Initialization - In a pizza ordering bot, if you can pass the user location as a session attribute (for example, "Location" : "111 Maple street"), then your Lambda function might use this information to determine the closest pizzeria to place the order (perhaps to set the storeAddress slot value).

  • Personalize prompts - For example, you can configure prompts to refer to the user name. (For example, "Hey [FirstName], what toppings would you like?"). You can pass the user name as a session attribute ("FirstName" : "Joe") so that Amazon Lex can substitute the placeholder to provide a personalize prompt to the user ("Hey Joe, what toppings would you like?").

Amazon Lex does not persist session attributes.

If you configure a code hook for the intent, Amazon Lex passes the incoming session attributes to the Lambda function. If you want Amazon Lex to return these session attributes back to the client, the Lambda function must return them.

If there is no code hook configured for the intent, Amazon Lex simply returns the session attributes back to the client application.

Returns:

  • (Hash<String,String>)


455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb', line 455

class PostTextRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :input_text)
  include Aws::Structure
end

#user_idString

The ID of the client application user. The application developer decides the user IDs. At runtime, each request must include the user ID. Typically, each of your application users should have a unique ID. Note the following considerations:

  • If you want a user to start a conversation on one device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

  • If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

Returns:

  • (String)


455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-lexruntimeservice/lib/aws-sdk-lexruntimeservice/types.rb', line 455

class PostTextRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :input_text)
  include Aws::Structure
end