@Generated(value="software.amazon.awssdk:codegen") public final class PutIntentRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutIntentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutIntentRequest.Builder |
builder() |
String |
checksum()
Identifies a specific revision of the
$LATEST version. |
Statement |
conclusionStatement()
The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the
Lambda function.
|
Prompt |
confirmationPrompt()
Prompts the user to confirm the intent.
|
String |
description()
A description of the intent.
|
CodeHook |
dialogCodeHook()
Specifies a Lambda function to invoke for each user input.
|
boolean |
equals(Object obj) |
FollowUpPrompt |
followUpPrompt()
Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.
|
FulfillmentActivity |
fulfillmentActivity()
Required.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
name()
The name of the intent.
|
String |
parentIntentSignature()
A unique identifier for the built-in intent to base this intent on.
|
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. |
List<String> |
sampleUtterances()
An array of utterances (strings) that a user might say to signal the intent.
|
static Class<? extends PutIntentRequest.Builder> |
serializableBuilderClass() |
List<Slot> |
slots()
An array of intent slots.
|
PutIntentRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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.
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.
public String description()
A description of the intent.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
In each utterance, a slot name is enclosed in curly braces.
public 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.
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.
public 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.
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.
public 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.
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.
public 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.
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.
public 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.
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.
public 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
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).
public 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.
public 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.
$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.
public PutIntentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>
toBuilder
in class LexModelBuildingRequest
public static PutIntentRequest.Builder builder()
public static Class<? extends PutIntentRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.