public static interface PutIntentRequest.Builder extends LexModelBuildingRequest.Builder, CopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>
| Modifier and Type | Method and Description |
|---|---|
PutIntentRequest.Builder |
checksum(String checksum)
Identifies 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.
|
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.
|
default PutIntentRequest.Builder |
confirmationPrompt(Consumer<Prompt.Builder> confirmationPrompt)
Prompts the user to confirm the intent.
|
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.
|
default PutIntentRequest.Builder |
dialogCodeHook(Consumer<CodeHook.Builder> 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.
|
PutIntentRequest.Builder |
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.
|
PutIntentRequest.Builder |
fulfillmentActivity(FulfillmentActivity fulfillmentActivity)
Required.
|
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.
|
default PutIntentRequest.Builder |
rejectionStatement(Consumer<Statement.Builder> 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 |
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 |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
PutIntentRequest.Builder |
requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)
Add an optional request override configuration.
|
PutIntentRequest.Builder |
sampleUtterances(Collection<String> sampleUtterances)
An array of utterances (strings) that a user might say to signal the intent.
|
PutIntentRequest.Builder |
sampleUtterances(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(Consumer<Slot.Builder>... slots)
An array of intent slots.
|
PutIntentRequest.Builder |
slots(Slot... slots)
An array of intent slots.
|
buildrequestOverrideConfigcopyapply, buildPutIntentRequest.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.
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.
PutIntentRequest.Builder description(String description)
A description of the intent.
description - A description of the intent.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.
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.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.
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.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 that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #slots(List) .slots - a consumer that will call methods on List.Builder #slots(List) 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.
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.
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.
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.
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.
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.
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.
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).confirmationPrompt - a consumer that will call methods on Prompt.BuilderconfirmationPrompt(Prompt)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.
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.
default PutIntentRequest.Builder rejectionStatement(Consumer<Statement.Builder> 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.
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 rejectionStatement(Statement).rejectionStatement - a consumer that will call methods on Statement.BuilderrejectionStatement(Statement)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.
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.
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.
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).followUpPrompt - a consumer that will call methods on FollowUpPrompt.BuilderfollowUpPrompt(FollowUpPrompt)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.
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.
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.
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).conclusionStatement - a consumer that will call methods on Statement.BuilderconclusionStatement(Statement)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.
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.
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.
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).dialogCodeHook - a consumer that will call methods on CodeHook.BuilderdialogCodeHook(CodeHook)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).
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).
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 that creates an instance of theFulfillmentActivity.Builder avoiding the need
to create one manually via FulfillmentActivity.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to fulfillmentActivity(FulfillmentActivity).fulfillmentActivity - a consumer that will call methods on FulfillmentActivity.BuilderfulfillmentActivity(FulfillmentActivity)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.
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.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.
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.
PutIntentRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.BuilderrequestOverrideConfig in interface AwsRequest.BuilderawsRequestOverrideConfig - The override configuration.PutIntentRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)
AwsRequest.BuilderrequestOverrideConfig in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.