Package software.amazon.awssdk.services.lexmodelsv2.model

Interface CreateIntentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateIntentRequest.Builder,CreateIntentRequest>, LexModelsV2Request.Builder, SdkBuilder<CreateIntentRequest.Builder,CreateIntentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateIntentRequest
public static interface CreateIntentRequest.Builder extends LexModelsV2Request.Builder, SdkPojo, CopyableBuilder<CreateIntentRequest.Builder,CreateIntentRequest>

  • Method Details

    • intentName

      CreateIntentRequest.Builder intentName(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateIntentRequest.Builder description(String description)

      A description of the intent. Use the description to help identify the intent in lists.

      Parameters:
      description - A description of the intent. Use the description to help identify the intent in lists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentIntentSignature

      CreateIntentRequest.Builder parentIntentSignature(String parentIntentSignature)

      A unique identifier for the built-in intent to base this intent on.

      Parameters:
      parentIntentSignature - A unique identifier for the built-in intent to base this intent on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleUtterances

      CreateIntentRequest.Builder sampleUtterances(Collection<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..

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleUtterances

      CreateIntentRequest.Builder sampleUtterances(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..

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleUtterances

      CreateIntentRequest.Builder sampleUtterances(Consumer<SampleUtterance.Builder>... 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..

      This is a convenience method that creates an instance of the SampleUtterance.Builder avoiding the need to create one manually via SampleUtterance.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sampleUtterances(List<SampleUtterance>).

      Parameters:
      sampleUtterances - a consumer that will call methods on SampleUtterance.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dialogCodeHook

      CreateIntentRequest.Builder dialogCodeHook(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dialogCodeHook

      default CreateIntentRequest.Builder dialogCodeHook(Consumer<DialogCodeHookSettings.Builder> 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.

      This is a convenience method that creates an instance of the DialogCodeHookSettings.Builder avoiding the need to create one manually via DialogCodeHookSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dialogCodeHook(DialogCodeHookSettings).

      Parameters:
      dialogCodeHook - a consumer that will call methods on DialogCodeHookSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fulfillmentCodeHook

      CreateIntentRequest.Builder fulfillmentCodeHook(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fulfillmentCodeHook

      default CreateIntentRequest.Builder fulfillmentCodeHook(Consumer<FulfillmentCodeHookSettings.Builder> 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.

      This is a convenience method that creates an instance of the FulfillmentCodeHookSettings.Builder avoiding the need to create one manually via FulfillmentCodeHookSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fulfillmentCodeHook(FulfillmentCodeHookSettings).

      Parameters:
      fulfillmentCodeHook - a consumer that will call methods on FulfillmentCodeHookSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • intentConfirmationSetting

      CreateIntentRequest.Builder intentConfirmationSetting(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intentConfirmationSetting

      default CreateIntentRequest.Builder intentConfirmationSetting(Consumer<IntentConfirmationSetting.Builder> 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.

      This is a convenience method that creates an instance of the IntentConfirmationSetting.Builder avoiding the need to create one manually via IntentConfirmationSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to intentConfirmationSetting(IntentConfirmationSetting).

      Parameters:
      intentConfirmationSetting - a consumer that will call methods on IntentConfirmationSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • intentClosingSetting

      CreateIntentRequest.Builder intentClosingSetting(IntentClosingSetting intentClosingSetting)

      Sets the response that Amazon Lex sends to the user when the intent is closed.

      Parameters:
      intentClosingSetting - Sets the response that Amazon Lex sends to the user when the intent is closed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intentClosingSetting

      default CreateIntentRequest.Builder intentClosingSetting(Consumer<IntentClosingSetting.Builder> intentClosingSetting)

      Sets the response that Amazon Lex sends to the user when the intent is closed.

      This is a convenience method that creates an instance of the IntentClosingSetting.Builder avoiding the need to create one manually via IntentClosingSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to intentClosingSetting(IntentClosingSetting).

      Parameters:
      intentClosingSetting - a consumer that will call methods on IntentClosingSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputContexts

      CreateIntentRequest.Builder inputContexts(Collection<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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputContexts

      CreateIntentRequest.Builder inputContexts(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputContexts

      CreateIntentRequest.Builder inputContexts(Consumer<InputContext.Builder>... 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.

      This is a convenience method that creates an instance of the InputContext.Builder avoiding the need to create one manually via InputContext.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputContexts(List<InputContext>).

      Parameters:
      inputContexts - a consumer that will call methods on InputContext.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputContexts

      CreateIntentRequest.Builder outputContexts(Collection<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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputContexts

      CreateIntentRequest.Builder outputContexts(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputContexts

      CreateIntentRequest.Builder outputContexts(Consumer<OutputContext.Builder>... 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.

      This is a convenience method that creates an instance of the OutputContext.Builder avoiding the need to create one manually via OutputContext.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputContexts(List<OutputContext>).

      Parameters:
      outputContexts - a consumer that will call methods on OutputContext.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kendraConfiguration

      CreateIntentRequest.Builder kendraConfiguration(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kendraConfiguration

      default CreateIntentRequest.Builder kendraConfiguration(Consumer<KendraConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the KendraConfiguration.Builder avoiding the need to create one manually via KendraConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kendraConfiguration(KendraConfiguration).

      Parameters:
      kendraConfiguration - a consumer that will call methods on KendraConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • botId

      CreateIntentRequest.Builder botId(String botId)

      The identifier of the bot associated with this intent.

      Parameters:
      botId - The identifier of the bot associated with this intent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botVersion

      CreateIntentRequest.Builder botVersion(String botVersion)

      The version of the bot associated with this intent.

      Parameters:
      botVersion - The version of the bot associated with this intent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localeId

      CreateIntentRequest.Builder localeId(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialResponseSetting

      CreateIntentRequest.Builder initialResponseSetting(InitialResponseSetting initialResponseSetting)

      Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

      Parameters:
      initialResponseSetting - Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialResponseSetting

      default CreateIntentRequest.Builder initialResponseSetting(Consumer<InitialResponseSetting.Builder> initialResponseSetting)

      Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.

      This is a convenience method that creates an instance of the InitialResponseSetting.Builder avoiding the need to create one manually via InitialResponseSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initialResponseSetting(InitialResponseSetting).

      Parameters:
      initialResponseSetting - a consumer that will call methods on InitialResponseSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • qnAIntentConfiguration

      CreateIntentRequest.Builder qnAIntentConfiguration(QnAIntentConfiguration qnAIntentConfiguration)

      Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

      Parameters:
      qnAIntentConfiguration - Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qnAIntentConfiguration

      default CreateIntentRequest.Builder qnAIntentConfiguration(Consumer<QnAIntentConfiguration.Builder> qnAIntentConfiguration)

      Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

      This is a convenience method that creates an instance of the QnAIntentConfiguration.Builder avoiding the need to create one manually via QnAIntentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to qnAIntentConfiguration(QnAIntentConfiguration).

      Parameters:
      qnAIntentConfiguration - a consumer that will call methods on QnAIntentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateIntentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateIntentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.