Package software.amazon.awssdk.services.lexmodelbuilding.model

Interface PutIntentRequest.Builder

    • Method Detail

      • name

        PutIntentRequest.Builder name​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        PutIntentRequest.Builder description​(String description)

        A description of the intent.

        Parameters:
        description - A description of the intent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slots

        PutIntentRequest.Builder slots​(Collection<Slot> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slots

        PutIntentRequest.Builder slots​(Slot... 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slots

        PutIntentRequest.Builder slots​(Consumer<Slot.Builder>... 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.

        This is a convenience method that creates an instance of the Slot.Builder avoiding the need to create one manually via Slot.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #slots(List).

        Parameters:
        slots - a consumer that will call methods on Slot.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #slots(java.util.Collection)

      • sampleUtterances

        PutIntentRequest.Builder sampleUtterances​(Collection<String> 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sampleUtterances

        PutIntentRequest.Builder sampleUtterances​(String... 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • confirmationPrompt

        PutIntentRequest.Builder confirmationPrompt​(Prompt 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.

        You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

        Parameters:
        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.

        You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • confirmationPrompt

        default PutIntentRequest.Builder confirmationPrompt​(Consumer<Prompt.Builder> 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.

        You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

        This is a convenience method that creates an instance of the Prompt.Builder avoiding the need to create one manually via Prompt.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to confirmationPrompt(Prompt).

        Parameters:
        confirmationPrompt - a consumer that will call methods on Prompt.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        confirmationPrompt(Prompt)

      • rejectionStatement

        PutIntentRequest.Builder rejectionStatement​(Statement 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.

        You must provide both the rejectionStatement and the confirmationPrompt, or neither.

        Parameters:
        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.

        You must provide both the rejectionStatement and the confirmationPrompt, or neither.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • followUpPrompt

        PutIntentRequest.Builder followUpPrompt​(FollowUpPrompt 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • followUpPrompt

        default PutIntentRequest.Builder followUpPrompt​(Consumer<FollowUpPrompt.Builder> 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.

        This is a convenience method that creates an instance of the FollowUpPrompt.Builder avoiding the need to create one manually via FollowUpPrompt.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to followUpPrompt(FollowUpPrompt).

        Parameters:
        followUpPrompt - a consumer that will call methods on FollowUpPrompt.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        followUpPrompt(FollowUpPrompt)

      • conclusionStatement

        PutIntentRequest.Builder conclusionStatement​(Statement 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.

        The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

        Parameters:
        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.

        The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • conclusionStatement

        default PutIntentRequest.Builder conclusionStatement​(Consumer<Statement.Builder> 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.

        The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

        This is a convenience method that creates an instance of the Statement.Builder avoiding the need to create one manually via Statement.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to conclusionStatement(Statement).

        Parameters:
        conclusionStatement - a consumer that will call methods on Statement.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        conclusionStatement(Statement)

      • dialogCodeHook

        PutIntentRequest.Builder dialogCodeHook​(CodeHook 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dialogCodeHook

        default PutIntentRequest.Builder dialogCodeHook​(Consumer<CodeHook.Builder> 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.

        This is a convenience method that creates an instance of the CodeHook.Builder avoiding the need to create one manually via CodeHook.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dialogCodeHook(CodeHook).

        Parameters:
        dialogCodeHook - a consumer that will call methods on CodeHook.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        dialogCodeHook(CodeHook)

      • fulfillmentActivity

        PutIntentRequest.Builder fulfillmentActivity​(FulfillmentActivity 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).

        Parameters:
        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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentIntentSignature

        PutIntentRequest.Builder parentIntentSignature​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksum

        PutIntentRequest.Builder checksum​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createVersion

        PutIntentRequest.Builder createVersion​(Boolean 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kendraConfiguration

        PutIntentRequest.Builder kendraConfiguration​(KendraConfiguration kendraConfiguration)

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

        Parameters:
        kendraConfiguration - Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputContexts

        PutIntentRequest.Builder inputContexts​(Collection<InputContext> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputContexts

        PutIntentRequest.Builder inputContexts​(InputContext... 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputContexts

        PutIntentRequest.Builder inputContexts​(Consumer<InputContext.Builder>... 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.

        This is a convenience method that creates an instance of the InputContext.Builder avoiding the need to create one manually via InputContext.builder() .

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inputContexts(List).

        Parameters:
        inputContexts - a consumer that will call methods on InputContext.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #inputContexts(java.util.Collection)

      • outputContexts

        PutIntentRequest.Builder outputContexts​(Collection<OutputContext> outputContexts)

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

        Parameters:
        outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputContexts

        PutIntentRequest.Builder outputContexts​(OutputContext... outputContexts)

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

        Parameters:
        outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputContexts

        PutIntentRequest.Builder outputContexts​(Consumer<OutputContext.Builder>... outputContexts)

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

        This is a convenience method that creates an instance of the OutputContext.Builder avoiding the need to create one manually via OutputContext.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #outputContexts(List).

        Parameters:
        outputContexts - a consumer that will call methods on OutputContext.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #outputContexts(java.util.Collection)