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

Class: Aws::Lex::Types::PutSessionResponse

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#audio_streamIO

The audio version of the message to convey to the user.

Returns:

  • (IO)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#content_typeString

Content type as specified in the Accept HTTP header in the request.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#dialog_stateString

  • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

  • ElicitIntent - Amazon Lex wants to elicit the user's intent.

  • ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

  • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#intent_nameString

The name of the current intent.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#messageString

The next message that should be presented to the user.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#message_formatString

The format of the response message. One of the following values:

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#session_attributesString

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

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#session_idString

A unique identifier for the session.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#slot_to_elicitString

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end

#slotsString

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

Returns:

  • (String)


1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 1299

class PutSessionResponse < Struct.new(
  :content_type,
  :intent_name,
  :slots,
  :session_attributes,
  :message,
  :message_format,
  :dialog_state,
  :slot_to_elicit,
  :audio_stream,
  :session_id)
  include Aws::Structure
end