Class: Aws::Lex::Types::IntentSummary

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

{
  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",
}

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

Constant Summary collapse

SENSITIVE =
[:slots]

Instance Attribute Summary collapse

Instance Attribute Details

#checkpoint_labelString

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#confirmation_statusString

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

  • Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

  • Denied - The user has responded "No" to the confirmation prompt.

  • None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#dialog_action_typeString

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#fulfillment_stateString

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#intent_nameString

The name of the intent.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#slot_to_elicitString

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end

#slotsHash<String,String>

Map of the slots that have been gathered and their values.

Returns:

  • (Hash<String,String>)


469
470
471
472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 469

class IntentSummary < Struct.new(
  :intent_name,
  :checkpoint_label,
  :slots,
  :confirmation_status,
  :dialog_action_type,
  :fulfillment_state,
  :slot_to_elicit)
  SENSITIVE = [:slots]
  include Aws::Structure
end