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

Class: Aws::Lex::Types::PostTextRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lex/lib/aws-sdk-lex/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",
  },
  request_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)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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

#bot_nameString

The name of the Amazon Lex bot.

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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

#input_textString

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

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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

#request_attributesHash<String,String>

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.

Returns:

  • (Hash<String,String>)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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

#session_attributesHash<String,String>

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

For more information, see Setting Session Attributes.

Returns:

  • (Hash<String,String>)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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

#user_idString

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.

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 450

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