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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutSessionRequest as input to an Aws::Client method, you can use a vanilla 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",
  active_contexts: [
    {
      name: "ActiveContextName", # required
      time_to_live: { # required
        time_to_live_in_seconds: 1,
        turns_to_live: 1,
      },
      parameters: { # required
        "ParameterName" => "Text",
      },
    },
  ],
}

See Also:

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) —

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

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

#bot_alias ⇒ String

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

Returns:

  • (String) —

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

#bot_name ⇒ String

The name of the bot that contains the session data.

Returns:

  • (String) —

    The name of the bot that contains the session data.

#dialog_action ⇒ Types::DialogAction

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

Returns:

  • (Types::DialogAction) —

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

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

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

    Map of key/value pairs representing the session-specific context information.

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

    The ID of the client application user.