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

Interface PutIntentRequest.Builder

All Superinterfaces:

CopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>, SdkBuilder<PutIntentRequest.Builder,PutIntentRequest>

Enclosing class:

PutIntentRequest

public static interface PutIntentRequest.Builder
extends CopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>

Method Summary

Modifier and Type	Method	Description
PutIntentRequest.Builder	checksum(String checksum)	Identifies a specific revision of the $LATEST version.
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.
PutIntentRequest.Builder	confirmationPrompt(Prompt confirmationPrompt)	Prompts the user to confirm the intent.
PutIntentRequest.Builder	description(String description)	A description of the intent.
PutIntentRequest.Builder	dialogCodeHook(CodeHook dialogCodeHook)	Specifies a Lambda function to invoke for each user input.
PutIntentRequest.Builder	followUpPrompt(FollowUpPrompt followUpPrompt)	A user prompt for additional activity after an intent is fulfilled.
PutIntentRequest.Builder	fulfillmentActivity(FulfillmentActivity fulfillmentActivity)	Describes how the intent is fulfilled.
PutIntentRequest.Builder	name(String name)	The name of the intent.
PutIntentRequest.Builder	parentIntentSignature(String parentIntentSignature)	A unique identifier for the built-in intent to base this intent on.
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.
PutIntentRequest.Builder	sampleUtterances(String... sampleUtterances)	An array of utterances (strings) that a user might say to signal the intent.
PutIntentRequest.Builder	sampleUtterances(Collection<String> sampleUtterances)	An array of utterances (strings) that a user might say to signal the intent.
PutIntentRequest.Builder	slots(Collection<Slot> slots)	An array of intent slots.
PutIntentRequest.Builder	slots(Slot... slots)	An array of intent slots.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

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 <xref linkend="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 <xref linkend="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 <xref linkend="how-it-works"/>.

NOTE: This method appends the values to the existing list (if any). Use #setSlots(java.util.Collection) or #withSlots(java.util.Collection) if you want to override the existing values.

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 <xref linkend="how-it-works"/>.

Returns:

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setSampleUtterances(java.util.Collection) or #withSampleUtterances(java.util.Collection) if you want to override the existing values.

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.

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)

A user prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled (your Lambda function placed an order with a pizzeria), you might prompt the user to find if they want to order a drink (assuming that you have defined an OrderDrink intent in your bot).

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one. For example, your bot may not solicit both the following:

Follow up prompt - "$session.FirstName, your pizza order has been placed. Would you like to order a drink or a dessert?"

Conclusion statement - "$session.FirstName, your pizza order has been placed."

Parameters:

followUpPrompt - A user prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled (your Lambda function placed an order with a pizzeria), you might prompt the user to find if they want to order a drink (assuming that you have defined an OrderDrink intent in your bot).

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one. For example, your bot may not solicit both the following:

Follow up prompt - "$session.FirstName, your pizza order has been placed. Would you like to order a drink or a dessert?"

Conclusion statement - "$session.FirstName, your pizza order has been placed."

Returns:

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

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.

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.

fulfillmentActivity

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

Parameters:

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

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.