putIntent method

Future<PutIntentResponse> putIntent({ required String name, String? checksum, Statement? conclusionStatement, Prompt? confirmationPrompt, bool? createVersion, String? description, CodeHook? dialogCodeHook, FollowUpPrompt? followUpPrompt, FulfillmentActivity? fulfillmentActivity, List<InputContext>? inputContexts, KendraConfiguration? kendraConfiguration, List<OutputContext>? outputContexts, String? parentIntentSignature, Statement? rejectionStatement, List<String>? sampleUtterances, List<Slot>? slots, })

Creates an intent or replaces an existing intent.

To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.

To create an intent or replace an existing intent, you must provide the following:

• Intent name. For example, OrderPizza.
• Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
• Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
• How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.

You can specify other optional information in the request, such as:

• A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
• A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
• A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT.

For more information, see how-it-works.

This operation requires permissions for the lex:PutIntent action.

May throw ConflictException. May throw LimitExceededException. May throw InternalFailureException. May throw BadRequestException. May throw PreconditionFailedException.

Parameter name : 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.

Parameter checksum : 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.

Parameter conclusionStatement : 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.

Parameter confirmationPrompt : 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.

Parameter createVersion : When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

Parameter description : A description of the intent.

Parameter dialogCodeHook : 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.

Parameter 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.

Parameter fulfillmentActivity : Required. 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).

Parameter inputContexts : An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Parameter kendraConfiguration : Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Parameter outputContexts : An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Parameter parentIntentSignature : 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.

Parameter rejectionStatement : When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

Parameter sampleUtterances : 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.

Parameter slots : 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 how-it-works.

Implementation

Future<PutIntentResponse> putIntent({
  required String name,
  String? checksum,
  Statement? conclusionStatement,
  Prompt? confirmationPrompt,
  bool? createVersion,
  String? description,
  CodeHook? dialogCodeHook,
  FollowUpPrompt? followUpPrompt,
  FulfillmentActivity? fulfillmentActivity,
  List<InputContext>? inputContexts,
  KendraConfiguration? kendraConfiguration,
  List<OutputContext>? outputContexts,
  String? parentIntentSignature,
  Statement? rejectionStatement,
  List<String>? sampleUtterances,
  List<Slot>? slots,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    100,
    isRequired: true,
  );
  _s.validateStringLength(
    'description',
    description,
    0,
    200,
  );
  final $payload = <String, dynamic>{
    if (checksum != null) 'checksum': checksum,
    if (conclusionStatement != null)
      'conclusionStatement': conclusionStatement,
    if (confirmationPrompt != null) 'confirmationPrompt': confirmationPrompt,
    if (createVersion != null) 'createVersion': createVersion,
    if (description != null) 'description': description,
    if (dialogCodeHook != null) 'dialogCodeHook': dialogCodeHook,
    if (followUpPrompt != null) 'followUpPrompt': followUpPrompt,
    if (fulfillmentActivity != null)
      'fulfillmentActivity': fulfillmentActivity,
    if (inputContexts != null) 'inputContexts': inputContexts,
    if (kendraConfiguration != null)
      'kendraConfiguration': kendraConfiguration,
    if (outputContexts != null) 'outputContexts': outputContexts,
    if (parentIntentSignature != null)
      'parentIntentSignature': parentIntentSignature,
    if (rejectionStatement != null) 'rejectionStatement': rejectionStatement,
    if (sampleUtterances != null) 'sampleUtterances': sampleUtterances,
    if (slots != null) 'slots': slots,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri: '/intents/${Uri.encodeComponent(name)}/versions/%24LATEST',
    exceptionFnMap: _exceptionFns,
  );
  return PutIntentResponse.fromJson(response);
}