Class: Aws::LexModelsV2::Types::CreateIntentRequest

Inherits:

Struct

Object
Struct
Aws::LexModelsV2::Types::CreateIntentRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lexmodelsv2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bot_id ⇒ String

The identifier of the bot associated with this intent.
#bot_version ⇒ String

The version of the bot associated with this intent.
#description ⇒ String

A description of the intent.
#dialog_code_hook ⇒ Types::DialogCodeHookSettings

Specifies that Amazon Lex invokes the alias Lambda function for each user input.
#fulfillment_code_hook ⇒ Types::FulfillmentCodeHookSettings

Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment.
#initial_response_setting ⇒ Types::InitialResponseSetting

Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
#input_contexts ⇒ Array<Types::InputContext>

A list of contexts that must be active for this intent to be considered by Amazon Lex.
#intent_closing_setting ⇒ Types::IntentClosingSetting

Sets the response that Amazon Lex sends to the user when the intent is closed.
#intent_confirmation_setting ⇒ Types::IntentConfirmationSetting

Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent.
#intent_name ⇒ String

The name of the intent.
#kendra_configuration ⇒ Types::KendraConfiguration

Configuration information required to use the ‘AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index.
#locale_id ⇒ String

The identifier of the language and locale where this intent is used.
#output_contexts ⇒ Array<Types::OutputContext>

A lists of contexts that the intent activates when it is fulfilled.
#parent_intent_signature ⇒ String

A unique identifier for the built-in intent to base this intent on.
#qn_a_intent_configuration ⇒ Types::QnAIntentConfiguration

Specifies the configuration of the built-in ‘Amazon.QnAIntent`.
#sample_utterances ⇒ Array<Types::SampleUtterance>

An array of strings that a user might say to signal the intent.

Instance Attribute Details

#bot_id ⇒ `String`

The identifier of the bot associated with this intent.

Returns:

(String)

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

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

#bot_version ⇒ `String`

The version of the bot associated with this intent.

Returns:

(String)

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

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

#description ⇒ `String`

A description of the intent. Use the description to help identify the intent in lists.

Returns:

(String)

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

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

#dialog_code_hook ⇒ `Types::DialogCodeHookSettings`

Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose that your bot determines that the user’s name is John. You Lambda function might retrieve John’s information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, ‘glutenIntolerant` to `true`. You might find John’s phone number and set the corresponding session attribute.

Returns:

(Types::DialogCodeHookSettings)

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

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

#fulfillment_code_hook ⇒ `Types::FulfillmentCodeHookSettings`

Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot’s transaction with the user.

For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer’s location and then place an order on the customer’s behalf.

Returns:

(Types::FulfillmentCodeHookSettings)

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

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

#initial_response_setting ⇒ `Types::InitialResponseSetting`

Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

Returns:

(Types::InitialResponseSetting)

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

class CreateIntentRequest < Struct.new(
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :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 this intent to be considered by Amazon Lex.

When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.

A context can be automatically activated using the ‘outputContexts` property or it can be set at runtime.

For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.

An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.

Returns:

(Array<Types::InputContext>)

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

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

#intent_closing_setting ⇒ `Types::IntentClosingSetting`

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

Returns:

(Types::IntentClosingSetting)

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

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

#intent_confirmation_setting ⇒ `Types::IntentConfirmationSetting`

Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers “no,” the settings contain a statement that is sent to the user to end the intent.

Returns:

(Types::IntentConfirmationSetting)

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

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

#intent_name ⇒ `String`

The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.

Returns:

(String)

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

class CreateIntentRequest < Struct.new(
  :intent_name,
  :description,
  :parent_intent_signature,
  :sample_utterances,
  :dialog_code_hook,
  :fulfillment_code_hook,
  :intent_confirmation_setting,
  :intent_closing_setting,
  :input_contexts,
  :output_contexts,
  :kendra_configuration,
  :bot_id,
  :bot_version,
  :locale_id,
  :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 to connect to an Amazon Kendra index. The `AMAZON.KendraSearchIntent` intent is called when Amazon Lex can’t determine another intent to invoke.

Returns:

(Types::KendraConfiguration)

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

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

#locale_id ⇒ `String`

The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see [Supported languages].

[1]: docs.aws.amazon.com/lexv2/latest/dg/how-languages.html

Returns:

(String)

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

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

#output_contexts ⇒ `Array<Types::OutputContext>`

A lists of contexts that the intent activates when it is fulfilled.

You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.

When you use the ‘outputContextsList` property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.

Returns:

(Array<Types::OutputContext>)

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

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

#parent_intent_signature ⇒ `String`

A unique identifier for the built-in intent to base this intent on.

Returns:

(String)

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

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

#qn_a_intent_configuration ⇒ `Types::QnAIntentConfiguration`

Specifies the configuration of the built-in ‘Amazon.QnAIntent`. The `AMAZON.QnAIntent` intent is called when Amazon Lex can’t determine another intent to invoke. If you specify this field, you can’t specify the ‘kendraConfiguration` field.

Returns:

(Types::QnAIntentConfiguration)

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

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

#sample_utterances ⇒ `Array<Types::SampleUtterance>`

An array of strings that a user might say to signal the intent. For example, “I want a pizza”, or “I want a PizzaSize pizza”.

In an utterance, slot names are enclosed in curly braces (““”) to indicate where they should be displayed in the utterance shown to the user..

Returns:

(Array<Types::SampleUtterance>)

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

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

Class: Aws::LexModelsV2::Types::CreateIntentRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bot_id ⇒ String

#bot_version ⇒ String

#description ⇒ String

#dialog_code_hook ⇒ Types::DialogCodeHookSettings

#fulfillment_code_hook ⇒ Types::FulfillmentCodeHookSettings

#initial_response_setting ⇒ Types::InitialResponseSetting

#input_contexts ⇒ Array<Types::InputContext>

#intent_closing_setting ⇒ Types::IntentClosingSetting

#intent_confirmation_setting ⇒ Types::IntentConfirmationSetting

#intent_name ⇒ String

#kendra_configuration ⇒ Types::KendraConfiguration

#locale_id ⇒ String

#output_contexts ⇒ Array<Types::OutputContext>

#parent_intent_signature ⇒ String

#qn_a_intent_configuration ⇒ Types::QnAIntentConfiguration

#sample_utterances ⇒ Array<Types::SampleUtterance>

#bot_id ⇒ `String`

#bot_version ⇒ `String`

#description ⇒ `String`

#dialog_code_hook ⇒ `Types::DialogCodeHookSettings`

#fulfillment_code_hook ⇒ `Types::FulfillmentCodeHookSettings`

#initial_response_setting ⇒ `Types::InitialResponseSetting`

#input_contexts ⇒ `Array<Types::InputContext>`

#intent_closing_setting ⇒ `Types::IntentClosingSetting`

#intent_confirmation_setting ⇒ `Types::IntentConfirmationSetting`

#intent_name ⇒ `String`

#kendra_configuration ⇒ `Types::KendraConfiguration`

#locale_id ⇒ `String`

#output_contexts ⇒ `Array<Types::OutputContext>`

#parent_intent_signature ⇒ `String`

#qn_a_intent_configuration ⇒ `Types::QnAIntentConfiguration`

#sample_utterances ⇒ `Array<Types::SampleUtterance>`