Class: Aws::Lex::Types::PutSessionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lex/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:session_attributes, :active_contexts]

Instance Attribute Summary collapse

Instance Attribute Details

#accept ⇒ String

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

  • If the value is ‘text/plain; charset=utf-8`, Amazon Lex returns text in the response.

  • If the value begins with ‘audio/`, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify `audio/mpeg` as the value, Amazon Lex returns speech in the MPEG format.

  • If the value is ‘audio/pcm`, the speech is returned as `audio/pcm` in 16-bit, little endian format.

  • The following are the accepted values:

    • ‘audio/mpeg`

    • ‘audio/ogg`

    • ‘audio/pcm`

    • ‘audio/*` (defaults to mpeg)

    • ‘text/plain; charset=utf-8`

Returns:

  • (String) 


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

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

Returns:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

#bot_alias ⇒ String

The alias in use for the bot that contains the session data.

Returns:

  • (String) 


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

#bot_name ⇒ String

The name of the bot that contains the session data.

Returns:

  • (String) 


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

#dialog_action ⇒ Types::DialogAction

Sets the next action that the bot should take to fulfill the conversation.

Returns:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

#recent_intent_summary_view ⇒ Array<Types::IntentSummary>

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

  • ‘intentName`

  • slot names

  • ‘slotToElict`

If you send the ‘recentIntentSummaryView` parameter in a `PutSession` request, the contents of the new summary view replaces the old summary view. For example, if a `GetSession` request returns three intents in the summary view and you call `PutSession` with one intent in the summary view, the next call to `GetSession` will only return one intent.

Returns:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end

#session_attributes ⇒ Hash<String,String>

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Returns:

  • (Hash<String,String>) 


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :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.

Returns:

  • (String) 


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/aws-sdk-lex/types.rb', line 1406

class PutSessionRequest < Struct.new(
  :bot_name,
  :bot_alias,
  :user_id,
  :session_attributes,
  :dialog_action,
  :recent_intent_summary_view,
  :accept,
  :active_contexts)
  SENSITIVE = [:session_attributes, :active_contexts]
  include Aws::Structure
end