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

Class PutIntentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingRequest
software.amazon.awssdk.services.lexmodelbuilding.model.PutIntentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutIntentRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>

  • Method Details

    • name

      public final 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.

      Returns:
      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.

    • description

      public final String description()

      A description of the intent.

      Returns:
      A description of the intent.

    • hasSlots

      public final boolean hasSlots()
      For responses, this returns true if the service returned a value for the Slots property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • slots

      public final 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.

      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 hasSlots() method.

      Returns:
      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.

    • hasSampleUtterances

      public final boolean hasSampleUtterances()
      For responses, this returns true if the service returned a value for the SampleUtterances property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • sampleUtterances

      public final 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.

      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.

      Returns:
      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.

    • confirmationPrompt

      public final 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.

      Returns:
      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.

    • rejectionStatement

      public final 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.

      Returns:
      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.

    • followUpPrompt

      public final 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.

      Returns:
      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.

    • conclusionStatement

      public final 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.

      Returns:
      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.

    • dialogCodeHook

      public final 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.

      Returns:
      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.

    • fulfillmentActivity

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

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

    • parentIntentSignature

      public final 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.

      Returns:
      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.

    • checksum

      public final 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.

      Returns:
      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.

    • createVersion

      public final Boolean createVersion()

      When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

      Returns:
      When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

    • kendraConfiguration

      public final KendraConfiguration kendraConfiguration()

      Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

      Returns:
      Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

    • hasInputContexts

      public final boolean hasInputContexts()
      For responses, this returns true if the service returned a value for the InputContexts property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • inputContexts

      public final List<InputContext> 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.

      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.

      Returns:
      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.

    • hasOutputContexts

      public final boolean hasOutputContexts()
      For responses, this returns true if the service returned a value for the OutputContexts property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • outputContexts

      public final List<OutputContext> outputContexts()

      An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

      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.

      Returns:
      An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

    • toBuilder

      public PutIntentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutIntentRequest.Builder,PutIntentRequest>
      Specified by:
      toBuilder in class LexModelBuildingRequest
      Returns:
      a builder for type T

    • builder

      public static PutIntentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutIntentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.