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

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 PutSessionRequest data as a hash:

{
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  session_attributes: {
    "String" => "String",
  },
  dialog_action: {
    type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    intent_name: "IntentName",
    slots: {
      "String" => "String",
    },
    slot_to_elicit: "String",
    fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
    message: "Text",
    message_format: "PlainText", # accepts PlainText, CustomPayload, SSML, Composite
  },
  recent_intent_summary_view: [
    {
      intent_name: "IntentName",
      checkpoint_label: "IntentSummaryCheckpointLabel",
      slots: {
        "String" => "String",
      },
      confirmation_status: "None", # accepts None, Confirmed, Denied
      dialog_action_type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
      fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
      slot_to_elicit: "String",
    },
  ],
  accept: "Accept",
}

Constant Summary collapse

SENSITIVE =
[:session_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#acceptString

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)


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

#bot_aliasString

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

Returns:

  • (String)


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

#bot_nameString

The name of the bot that contains the session data.

Returns:

  • (String)


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

#dialog_actionTypes::DialogAction

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

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

#recent_intent_summary_viewArray<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:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

#session_attributesHash<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>)


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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

Returns:

  • (String)


1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1255

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