PutIntentRequest

public struct PutIntentRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • 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.

    Declaration

    Swift

    public let checksum: String?
  • 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. The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

    Declaration

    Swift

    public let conclusionStatement: Statement?
  • 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. You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

    Declaration

    Swift

    public let confirmationPrompt: Prompt?
  • 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.

    Declaration

    Swift

    public let createVersion: Bool?
  • A description of the intent.

    Declaration

    Swift

    public let description: String?
  • 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.

    Declaration

    Swift

    public let dialogCodeHook: CodeHook?
  • 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.

    Declaration

    Swift

    public let followUpPrompt: FollowUpPrompt?
  • 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).

    Declaration

    Swift

    public let fulfillmentActivity: FulfillmentActivity?
  • Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

    Declaration

    Swift

    public let kendraConfiguration: KendraConfiguration?
  • 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.

    Declaration

    Swift

    public let name: 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.

    Declaration

    Swift

    public let parentIntentSignature: String?
  • When the user answers “no” to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. You must provide both the rejectionStatement and the confirmationPrompt, or neither.

    Declaration

    Swift

    public let rejectionStatement: Statement?
  • 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.

    Declaration

    Swift

    public let sampleUtterances: [String]?
  • 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.

    Declaration

    Swift

    public let slots: [Slot]?
  • Undocumented

    Declaration

    Swift

    public init(checksum: String? = nil, conclusionStatement: Statement? = nil, confirmationPrompt: Prompt? = nil, createVersion: Bool? = nil, description: String? = nil, dialogCodeHook: CodeHook? = nil, followUpPrompt: FollowUpPrompt? = nil, fulfillmentActivity: FulfillmentActivity? = nil, kendraConfiguration: KendraConfiguration? = nil, name: String, parentIntentSignature: String? = nil, rejectionStatement: Statement? = nil, sampleUtterances: [String]? = nil, slots: [Slot]? = nil)
  • Declaration

    Swift

    public func validate(name: String) throws