Class: Aws::LexModelsV2::Types::DescribeIntentResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::DescribeIntentResponse

Defined in:

gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The identifier of the bot associated with the intent.

• #bot_version ⇒ String

  The version of the bot associated with the intent.

• #creation_date_time ⇒ Time

  A timestamp of the date and time that the intent was created.

• #description ⇒ String

  The description of the intent.

• #dialog_code_hook ⇒ Types::DialogCodeHookSettings

  The Lambda function called during each turn of a conversation with the intent.

• #fulfillment_code_hook ⇒ Types::FulfillmentCodeHookSettings

  The Lambda function called when the intent is complete and ready for fulfillment.

• #initial_response_setting ⇒ Types::InitialResponseSetting

  Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

• #input_contexts ⇒ Array<Types::InputContext>

  A list of contexts that must be active for the intent to be considered for sending to the user.

• #intent_closing_setting ⇒ Types::IntentClosingSetting

  The response that Amazon Lex sends to when the intent is closed.

• #intent_confirmation_setting ⇒ Types::IntentConfirmationSetting

  Prompts that Amazon Lex sends to the user to confirm completion of an intent.

• #intent_id ⇒ String

  The unique identifier assigned to the intent when it was created.

• #intent_name ⇒ String

  The name specified for the intent.

• #kendra_configuration ⇒ Types::KendraConfiguration

  Configuration information required to use the AMAZON.KendraSearchIntent intent.

• #last_updated_date_time ⇒ Time

  A timestamp of the date and time that the intent was last updated.

• #locale_id ⇒ String

  The language and locale specified for the intent.

• #output_contexts ⇒ Array<Types::OutputContext>

  A list of contexts that are activated when the intent is fulfilled.

• #parent_intent_signature ⇒ String

  The identifier of the built-in intent that this intent is derived from, if any.

• #qn_a_intent_configuration ⇒ Types::QnAIntentConfiguration

  Details about the configuration of the built-in Amazon.QnAIntent.

• #sample_utterances ⇒ Array<Types::SampleUtterance>

  User utterances that trigger this intent.

• #slot_priorities ⇒ Array<Types::SlotPriority>

  The list that determines the priority that slots should be elicited from the user.

Instance Attribute Details

#bot_id ⇒ String

The identifier of the bot associated with the intent.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#bot_version ⇒ String

The version of the bot associated with the intent.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ Time

A timestamp of the date and time that the intent was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the intent.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dialog_code_hook ⇒ Types::DialogCodeHookSettings

The Lambda function called during each turn of a conversation with the intent.

Returns:

• (Types::DialogCodeHookSettings)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#fulfillment_code_hook ⇒ Types::FulfillmentCodeHookSettings

The Lambda function called when the intent is complete and ready for fulfillment.

Returns:

• (Types::FulfillmentCodeHookSettings)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#initial_response_setting ⇒ Types::InitialResponseSetting

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Returns:

• (Types::InitialResponseSetting)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#input_contexts ⇒ Array<Types::InputContext>

A list of contexts that must be active for the intent to be considered for sending to the user.

Returns:

• (Array<Types::InputContext>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#intent_closing_setting ⇒ Types::IntentClosingSetting

The response that Amazon Lex sends to when the intent is closed.

Returns:

• (Types::IntentClosingSetting)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#intent_confirmation_setting ⇒ Types::IntentConfirmationSetting

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

Returns:

• (Types::IntentConfirmationSetting)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#intent_id ⇒ String

The unique identifier assigned to the intent when it was created.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#intent_name ⇒ String

The name specified for the intent.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kendra_configuration ⇒ Types::KendraConfiguration

Configuration information required to use the AMAZON.KendraSearchIntent intent.

Returns:

• (Types::KendraConfiguration)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ Time

A timestamp of the date and time that the intent was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The language and locale specified for the intent.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_contexts ⇒ Array<Types::OutputContext>

A list of contexts that are activated when the intent is fulfilled.

Returns:

• (Array<Types::OutputContext>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#parent_intent_signature ⇒ String

The identifier of the built-in intent that this intent is derived from, if any.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#qn_a_intent_configuration ⇒ Types::QnAIntentConfiguration

Details about the configuration of the built-in Amazon.QnAIntent.

Returns:

• (Types::QnAIntentConfiguration)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sample_utterances ⇒ Array<Types::SampleUtterance>

User utterances that trigger this intent.

Returns:

• (Array<Types::SampleUtterance>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#slot_priorities ⇒ Array<Types::SlotPriority>

The list that determines the priority that slots should be elicited from the user.

Returns:

• (Array<Types::SlotPriority>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6501

class DescribeIntentResponse < Struct.new(
  :intent_id,
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :slot_priorities,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :creation_date_time,
  :last_updated_date_time,
  :initial_response_setting,
  :qn_a_intent_configuration)
  SENSITIVE = []
  include Aws::Structure
end