Interface PutIntentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PutIntentRequest.Builder,
,PutIntentRequest> LexModelBuildingRequest.Builder
,SdkBuilder<PutIntentRequest.Builder,
,PutIntentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutIntentRequest
-
Method Summary
Modifier and TypeMethodDescriptionIdentifies a specific revision of the$LATEST
version.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.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.default PutIntentRequest.Builder
confirmationPrompt
(Consumer<Prompt.Builder> confirmationPrompt) Prompts the user to confirm the intent.confirmationPrompt
(Prompt confirmationPrompt) Prompts the user to confirm the intent.createVersion
(Boolean createVersion) When set totrue
a new numbered version of the intent is created.description
(String description) A description of the intent.default PutIntentRequest.Builder
dialogCodeHook
(Consumer<CodeHook.Builder> dialogCodeHook) Specifies a Lambda function to invoke for each user input.dialogCodeHook
(CodeHook dialogCodeHook) Specifies a Lambda function to invoke for each user input.default PutIntentRequest.Builder
followUpPrompt
(Consumer<FollowUpPrompt.Builder> followUpPrompt) Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.followUpPrompt
(FollowUpPrompt followUpPrompt) Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.default PutIntentRequest.Builder
fulfillmentActivity
(Consumer<FulfillmentActivity.Builder> fulfillmentActivity) Required.fulfillmentActivity
(FulfillmentActivity fulfillmentActivity) Required.inputContexts
(Collection<InputContext> inputContexts) An array ofInputContext
objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.inputContexts
(Consumer<InputContext.Builder>... inputContexts) An array ofInputContext
objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.inputContexts
(InputContext... inputContexts) An array ofInputContext
objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.default PutIntentRequest.Builder
kendraConfiguration
(Consumer<KendraConfiguration.Builder> kendraConfiguration) Configuration information required to use theAMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index.kendraConfiguration
(KendraConfiguration kendraConfiguration) Configuration information required to use theAMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index.The name of the intent.outputContexts
(Collection<OutputContext> outputContexts) An array ofOutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.outputContexts
(Consumer<OutputContext.Builder>... outputContexts) An array ofOutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.outputContexts
(OutputContext... outputContexts) An array ofOutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parentIntentSignature
(String parentIntentSignature) A unique identifier for the built-in intent to base this intent on.default PutIntentRequest.Builder
rejectionStatement
(Consumer<Statement.Builder> rejectionStatement) When the user answers "no" to the question defined inconfirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.rejectionStatement
(Statement rejectionStatement) When the user answers "no" to the question defined inconfirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.sampleUtterances
(String... sampleUtterances) An array of utterances (strings) that a user might say to signal the intent.sampleUtterances
(Collection<String> sampleUtterances) An array of utterances (strings) that a user might say to signal the intent.slots
(Collection<Slot> slots) An array of intent slots.slots
(Consumer<Slot.Builder>... slots) An array of intent slots.An array of intent slots.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 calledHelpIntent
.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 calledHelpIntent
.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
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
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
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
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 theSlot.Builder
avoiding the need to create one manually viaSlot.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toslots(List<Slot>)
.- Parameters:
slots
- a consumer that will call methods onSlot.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theconfirmationPrompt
, 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 theconfirmationPrompt
, or neither.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theconfirmationPrompt
, or neither.Prompt.Builder
avoiding the need to create one manually viaPrompt.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfirmationPrompt(Prompt)
.- Parameters:
confirmationPrompt
- a consumer that will call methods onPrompt.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theconfirmationPrompt
, or neither.- Parameters:
rejectionStatement
- When the user answers "no" to the question defined inconfirmationPrompt
, Amazon Lex responds with this statement to acknowledge that the intent was canceled.You must provide both the
rejectionStatement
and theconfirmationPrompt
, or neither.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theconfirmationPrompt
, or neither.Statement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torejectionStatement(Statement)
.- Parameters:
rejectionStatement
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theconclusionStatement
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 theOrderPizza
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 theconclusionStatement
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
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
This is a convenience method that creates an instance of thefollowUpPrompt
field and theconclusionStatement
field are mutually exclusive. You can specify only one.FollowUpPrompt.Builder
avoiding the need to create one manually viaFollowUpPrompt.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofollowUpPrompt(FollowUpPrompt)
.- Parameters:
followUpPrompt
- a consumer that will call methods onFollowUpPrompt.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
andconclusionStatement
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
andconclusionStatement
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
andconclusionStatement
are mutually exclusive. You can specify only one.Statement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconclusionStatement(Statement)
.- Parameters:
conclusionStatement
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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,
This is a convenience method that creates an instance of theGlutenIntolerant
, to true. You might find John's phone number and set the corresponding session attribute.CodeHook.Builder
avoiding the need to create one manually viaCodeHook.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todialogCodeHook(CodeHook)
.- Parameters:
dialogCodeHook
- a consumer that will call methods onCodeHook.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
fulfillmentActivity
default PutIntentRequest.Builder fulfillmentActivity(Consumer<FulfillmentActivity.Builder> 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).
This is a convenience method that creates an instance of theFulfillmentActivity.Builder
avoiding the need to create one manually viaFulfillmentActivity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofulfillmentActivity(FulfillmentActivity)
.- Parameters:
fulfillmentActivity
- a consumer that will call methods onFulfillmentActivity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 aBadRequestException
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 thechecksum
field, or if the checksum does not match the$LATEST
version, you get aPreconditionFailedException
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 aBadRequestException
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 thechecksum
field, or if the checksum does not match the$LATEST
version, you get aPreconditionFailedException
exception.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createVersion
When set to
true
a new numbered version of the intent is created. This is the same as calling theCreateIntentVersion
operation. If you do not specifycreateVersion
, the default isfalse
.- Parameters:
createVersion
- When set totrue
a new numbered version of the intent is created. This is the same as calling theCreateIntentVersion
operation. If you do not specifycreateVersion
, the default isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theAMAZON.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.
-
kendraConfiguration
default PutIntentRequest.Builder kendraConfiguration(Consumer<KendraConfiguration.Builder> kendraConfiguration) Configuration information required to use the
This is a convenience method that creates an instance of theAMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.KendraConfiguration.Builder
avoiding the need to create one manually viaKendraConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokendraConfiguration(KendraConfiguration)
.- Parameters:
kendraConfiguration
- a consumer that will call methods onKendraConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 ofInputContext
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
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 ofInputContext
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
An array of
This is a convenience method that creates an instance of theInputContext
objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.InputContext.Builder
avoiding the need to create one manually viaInputContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputContexts(List<InputContext>)
.- Parameters:
inputContexts
- a consumer that will call methods onInputContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputContexts
An array of
OutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.- Parameters:
outputContexts
- An array ofOutputContext
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
An array of
OutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.- Parameters:
outputContexts
- An array ofOutputContext
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
An array of
This is a convenience method that creates an instance of theOutputContext
objects that lists the contexts that the intent activates when the intent is fulfilled.OutputContext.Builder
avoiding the need to create one manually viaOutputContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputContexts(List<OutputContext>)
.- Parameters:
outputContexts
- a consumer that will call methods onOutputContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PutIntentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PutIntentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-