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

Interface PutBotResponse.Builder

    • Method Detail

      • name

        PutBotResponse.Builder name​(String name)

        The name of the bot.

        Parameters:
        name - The name of the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        PutBotResponse.Builder description​(String description)

        A description of the bot.

        Parameters:
        description - A description of the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • intents

        PutBotResponse.Builder intents​(Collection<Intent> intents)

        An array of Intent objects. For more information, see PutBot.

        Parameters:
        intents - An array of Intent objects. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • intents

        PutBotResponse.Builder intents​(Intent... intents)

        An array of Intent objects. For more information, see PutBot.

        Parameters:
        intents - An array of Intent objects. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • intents

        PutBotResponse.Builder intents​(Consumer<Intent.Builder>... intents)

        An array of Intent objects. For more information, see PutBot.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #intents(List).

        Parameters:
        intents - a consumer that will call methods on Intent.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #intents(java.util.Collection)

      • enableModelImprovements

        PutBotResponse.Builder enableModelImprovements​(Boolean enableModelImprovements)

        Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

        Parameters:
        enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nluIntentConfidenceThreshold

        PutBotResponse.Builder nluIntentConfidenceThreshold​(Double nluIntentConfidenceThreshold)

        The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

        Parameters:
        nluIntentConfidenceThreshold - The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clarificationPrompt

        PutBotResponse.Builder clarificationPrompt​(Prompt clarificationPrompt)

        The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

        Parameters:
        clarificationPrompt - The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • abortStatement

        PutBotResponse.Builder abortStatement​(Statement abortStatement)

        The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

        Parameters:
        abortStatement - The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        PutBotResponse.Builder status​(String status)

        When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

        In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

        If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

        When the bot is in the READY state you can test and publish the bot.

        Parameters:
        status - When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

        In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

        If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

        When the bot is in the READY state you can test and publish the bot.

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

      • status

        PutBotResponse.Builder status​(Status status)

        When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

        In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

        If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

        When the bot is in the READY state you can test and publish the bot.

        Parameters:
        status - When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

        In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

        If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

        When the bot is in the READY state you can test and publish the bot.

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

      • failureReason

        PutBotResponse.Builder failureReason​(String failureReason)

        If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

        Parameters:
        failureReason - If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedDate

        PutBotResponse.Builder lastUpdatedDate​(Instant lastUpdatedDate)

        The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

        Parameters:
        lastUpdatedDate - The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        PutBotResponse.Builder createdDate​(Instant createdDate)

        The date that the bot was created.

        Parameters:
        createdDate - The date that the bot was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • idleSessionTTLInSeconds

        PutBotResponse.Builder idleSessionTTLInSeconds​(Integer idleSessionTTLInSeconds)

        The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

        Parameters:
        idleSessionTTLInSeconds - The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • voiceId

        PutBotResponse.Builder voiceId​(String voiceId)

        The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

        Parameters:
        voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • checksum

        PutBotResponse.Builder checksum​(String checksum)

        Checksum of the bot that you created.

        Parameters:
        checksum - Checksum of the bot that you created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • version

        PutBotResponse.Builder version​(String version)

        The version of the bot. For a new bot, the version is always $LATEST.

        Parameters:
        version - The version of the bot. For a new bot, the version is always $LATEST.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locale

        PutBotResponse.Builder locale​(String locale)

        The target locale for the bot.

        Parameters:
        locale - The target locale for the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Locale, Locale

      • locale

        PutBotResponse.Builder locale​(Locale locale)

        The target locale for the bot.

        Parameters:
        locale - The target locale for the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Locale, Locale

      • childDirected

        PutBotResponse.Builder childDirected​(Boolean childDirected)

        For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

        If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

        Parameters:
        childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

        If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

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

      • createVersion

        PutBotResponse.Builder createVersion​(Boolean createVersion)

        True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

        Parameters:
        createVersion - True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • detectSentiment

        PutBotResponse.Builder detectSentiment​(Boolean detectSentiment)

        true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

        Parameters:
        detectSentiment - true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        PutBotResponse.Builder tags​(Collection<Tag> tags)

        A list of tags associated with the bot.

        Parameters:
        tags - A list of tags associated with the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        PutBotResponse.Builder tags​(Tag... tags)

        A list of tags associated with the bot.

        Parameters:
        tags - A list of tags associated with the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        PutBotResponse.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of tags associated with the bot.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)