@Generated(value="software.amazon.awssdk:codegen") public final class CreateIntentRequest extends LexModelsV2Request implements ToCopyableBuilder<CreateIntentRequest.Builder,CreateIntentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateIntentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
botId()
The identifier of the bot associated with this intent.
|
String |
botVersion()
The identifier of the version of the bot associated with this intent.
|
static CreateIntentRequest.Builder |
builder() |
String |
description()
A description of the intent.
|
DialogCodeHookSettings |
dialogCodeHook()
Specifies that Amazon Lex invokes the alias Lambda function for each user input.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
FulfillmentCodeHookSettings |
fulfillmentCodeHook()
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasInputContexts()
For responses, this returns true if the service returned a value for the InputContexts property.
|
boolean |
hasOutputContexts()
For responses, this returns true if the service returned a value for the OutputContexts property.
|
boolean |
hasSampleUtterances()
For responses, this returns true if the service returned a value for the SampleUtterances property.
|
List<InputContext> |
inputContexts()
A list of contexts that must be active for this intent to be considered by Amazon Lex.
|
IntentClosingSetting |
intentClosingSetting()
Sets the response that Amazon Lex sends to the user when the intent is closed.
|
IntentConfirmationSetting |
intentConfirmationSetting()
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent.
|
String |
intentName()
The name of the intent.
|
KendraConfiguration |
kendraConfiguration()
Configuration information required to use the
AMAZON.KendraSearchIntent intent to connect to an
Amazon Kendra index. |
String |
localeId()
The identifier of the language and locale where this intent is used.
|
List<OutputContext> |
outputContexts()
A lists of contexts that the intent activates when it is fulfilled.
|
String |
parentIntentSignature()
A unique identifier for the built-in intent to base this intent on.
|
List<SampleUtterance> |
sampleUtterances()
An array of strings that a user might say to signal the intent.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateIntentRequest.Builder> |
serializableBuilderClass() |
CreateIntentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String intentName()
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
public final String description()
A description of the intent. Use the description to help identify the intent in lists.
public final String parentIntentSignature()
A unique identifier for the built-in intent to base this intent on.
public final boolean hasSampleUtterances()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<SampleUtterance> sampleUtterances()
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSampleUtterances() method.
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
public final DialogCodeHookSettings dialogCodeHook()
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You 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 that your bot determines that the user's name is John. You 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 final FulfillmentCodeHookSettings fulfillmentCodeHook()
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
public final IntentConfirmationSetting intentConfirmationSetting()
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
public final IntentClosingSetting intentClosingSetting()
Sets the response that Amazon Lex sends to the user when the intent is closed.
public final boolean hasInputContexts()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<InputContext> inputContexts()
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts property or it can be set at
runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasInputContexts() method.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts property or it can be set
at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
public final boolean hasOutputContexts()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<OutputContext> outputContexts()
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList property, all of the contexts specified in the list are
activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of
conversation turns that the context should be active, or the length of time that the context should be active.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOutputContexts() method.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList property, all of the contexts specified in the list are
activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number
of conversation turns that the context should be active, or the length of time that the context should be
active.
public final KendraConfiguration kendraConfiguration()
Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an
Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine
another intent to invoke.
AMAZON.KendraSearchIntent intent to connect to
an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't
determine another intent to invoke.public final String botId()
The identifier of the bot associated with this intent.
public final String botVersion()
The identifier of the version of the bot associated with this intent.
public final String localeId()
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.
public CreateIntentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateIntentRequest.Builder,CreateIntentRequest>toBuilder in class LexModelsV2Requestpublic static CreateIntentRequest.Builder builder()
public static Class<? extends CreateIntentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.