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

Inherits:

Struct

• Object
• Struct
• Aws::Lex::Types::PostTextRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lex/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:session_attributes, :request_attributes, :input_text, :active_contexts]

Instance Attribute Summary

• #active_contexts ⇒ Array<Types::ActiveContext>

  A list of contexts active for the request.

• #bot_alias ⇒ String

  The alias of the Amazon Lex bot.

• #bot_name ⇒ String

  The name of the Amazon Lex bot.

• #input_text ⇒ String

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

• #request_attributes ⇒ Hash<String,String>

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

• #session_attributes ⇒ Hash<String,String>

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

• #user_id ⇒ String

  The ID of the client application user.

Instance Attribute Details

#active_contexts ⇒ Array<Types::ActiveContext>

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.

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#bot_alias ⇒ String

The alias of the Amazon Lex bot.

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#bot_name ⇒ String

The name of the Amazon Lex bot.

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#input_text ⇒ String

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

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#request_attributes ⇒ Hash<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].

[1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#session_attributes ⇒ Hash<String,String>

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

For more information, see [Setting Session Attributes].

[1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs

# File 'lib/aws-sdk-lex/types.rb', line 1082

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

#user_id ⇒ 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.

# File 'lib/aws-sdk-lex/types.rb', line 1082

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