Class: Aws::LexModelBuildingService::Types::PutIntentRequest

Inherits:

Struct

Object
Struct
Aws::LexModelBuildingService::Types::PutIntentRequest

show all

Includes:: Structure

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

Overview

Note:

When making an API call, you may pass PutIntentRequest data as a hash:

{
  name: "IntentName", # required
  description: "Description",
  slots: [
    {
      name: "SlotName", # required
      description: "Description",
      slot_constraint: "Required", # required, accepts Required, Optional
      slot_type: "CustomOrBuiltinSlotTypeName",
      slot_type_version: "Version",
      value_elicitation_prompt: {
        messages: [ # required
          {
            content_type: "PlainText", # required, accepts PlainText, SSML
            content: "ContentString", # required
          },
        ],
        max_attempts: 1, # required
        response_card: "ResponseCard",
      },
      priority: 1,
      sample_utterances: ["Utterance"],
      response_card: "ResponseCard",
    },
  ],
  sample_utterances: ["Utterance"],
  confirmation_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  rejection_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    response_card: "ResponseCard",
  },
  follow_up_prompt: {
    prompt: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML
          content: "ContentString", # required
        },
      ],
      max_attempts: 1, # required
      response_card: "ResponseCard",
    },
    rejection_statement: { # required
      messages: [ # required
        {
          content_type: "PlainText", # required, accepts PlainText, SSML
          content: "ContentString", # required
        },
      ],
      response_card: "ResponseCard",
    },
  },
  conclusion_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    response_card: "ResponseCard",
  },
  dialog_code_hook: {
    uri: "LambdaARN", # required
    message_version: "MessageVersion", # required
  },
  fulfillment_activity: {
    type: "ReturnIntent", # required, accepts ReturnIntent, CodeHook
    code_hook: {
      uri: "LambdaARN", # required
      message_version: "MessageVersion", # required
    },
  },
  parent_intent_signature: "BuiltinIntentSignature",
  checksum: "String",
}

Instance Attribute Summary collapse

#checksum ⇒ String

Identifies a specific revision of the ‘$LATEST` version.
#conclusion_statement ⇒ Types::Statement

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.
#confirmation_prompt ⇒ Types::Prompt

Prompts the user to confirm the intent.
#description ⇒ String

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

Specifies a Lambda function to invoke for each user input.
#follow_up_prompt ⇒ Types::FollowUpPrompt

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.
#fulfillment_activity ⇒ Types::FulfillmentActivity

Describes how the intent is fulfilled.
#name ⇒ String

The name of the intent.
#parent_intent_signature ⇒ String

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

When the user answers “no” to the question defined in ‘confirmationPrompt`, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
#sample_utterances ⇒ Array<String>

An array of utterances (strings) that a user might say to signal the intent.
#slots ⇒ Array<Types::Slot>

An array of intent slots.

Instance Attribute Details

#checksum ⇒ `String`

Identifies a specific revision of the ‘$LATEST` version.

When you create a new intent, leave the ‘checksum` field blank. If you specify a checksum you get a `BadRequestException` exception.

When you want to update a intent, set the ‘checksum` field to the checksum of the most recent revision of the `$LATEST` version. If you don’t specify the ‘ checksum` field, or if the checksum does not match the `$LATEST` version, you get a `PreconditionFailedException` exception.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#conclusion_statement ⇒ `Types::Statement`

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the ‘fulfillmentActivity`. If you return the intent to the client application, you can’t specify this element.

<note markdown=“1”> The ‘followUpPrompt` and `conclusionStatement` are mutually exclusive. You can specify only one.

</note>

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#confirmation_prompt ⇒ `Types::Prompt`

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the ‘OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

<note markdown=“1”> You you must provide both the ‘rejectionStatement` and the `confirmationPrompt`, or neither.

</note>

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#description ⇒ `String`

A description of the intent.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#dialog_code_hook ⇒ `Types::CodeHook`

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your 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.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#follow_up_prompt ⇒ `Types::FollowUpPrompt`

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the ‘OrderPizza` intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user’s response, as follows:

If the user says “Yes” it responds with the clarification prompt that is configured for the bot.
if the user says “Yes” and continues with an utterance that triggers an intent it starts a conversation for the intent.
If the user says “No” it responds with the rejection statement configured for the the follow-up prompt.
If it doesn’t recognize the utterance it repeats the follow-up prompt again.

The ‘followUpPrompt` field and the `conclusionStatement` field are mutually exclusive. You can specify only one.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#fulfillment_activity ⇒ `Types::FulfillmentActivity`

Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, ‘fulfillmentActivity` defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#name ⇒ `String`

The name of the intent. The name is not case sensitive.

The name can’t match a built-in intent name, or a built-in intent name with “AMAZON.” removed. For example, because there is a built-in intent called ‘AMAZON.HelpIntent`, you can’t create a custom intent called ‘HelpIntent`.

For a list of built-in intents, see [Standard Built-in Intents] in the *Alexa Skills Kit*.

[1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#parent_intent_signature ⇒ `String`

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see [Standard Built-in Intents] in the *Alexa Skills Kit*.

[1]: developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#rejection_statement ⇒ `Types::Statement`

When the user answers “no” to the question defined in ‘confirmationPrompt`, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

<note markdown=“1”> You must provide both the ‘rejectionStatement` and the `confirmationPrompt`, or neither.

</note>

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#sample_utterances ⇒ `Array<String>`

An array of utterances (strings) that a user might say to signal the intent. For example, “I want {PizzaSize\} pizza”, “Order {Quantity\} {PizzaSize\} pizzas”.

In each utterance, a slot name is enclosed in curly braces.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

#slots ⇒ `Array<Types::Slot>`

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see <xref linkend=“how-it-works”/>.

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2871

class PutIntentRequest < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :checksum)
  include Aws::Structure
end

Class: Aws::LexModelBuildingService::Types::PutIntentRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#checksum ⇒ String

#conclusion_statement ⇒ Types::Statement

#confirmation_prompt ⇒ Types::Prompt

#description ⇒ String

#dialog_code_hook ⇒ Types::CodeHook

#follow_up_prompt ⇒ Types::FollowUpPrompt

#fulfillment_activity ⇒ Types::FulfillmentActivity

#name ⇒ String

#parent_intent_signature ⇒ String

#rejection_statement ⇒ Types::Statement

#sample_utterances ⇒ Array<String>

#slots ⇒ Array<Types::Slot>