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

Interface PromptSpecification.Builder

    • Method Detail

      • messageGroups

        PromptSpecification.Builder messageGroups​(Collection<MessageGroup> messageGroups)

        A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

        Parameters:
        messageGroups - A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageGroups

        PromptSpecification.Builder messageGroups​(MessageGroup... messageGroups)

        A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

        Parameters:
        messageGroups - A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageGroups

        PromptSpecification.Builder messageGroups​(Consumer<MessageGroup.Builder>... messageGroups)

        A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

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

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

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

      • maxRetries

        PromptSpecification.Builder maxRetries​(Integer maxRetries)

        The maximum number of times the bot tries to elicit a response from the user using this prompt.

        Parameters:
        maxRetries - The maximum number of times the bot tries to elicit a response from the user using this prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allowInterrupt

        PromptSpecification.Builder allowInterrupt​(Boolean allowInterrupt)

        Indicates whether the user can interrupt a speech prompt from the bot.

        Parameters:
        allowInterrupt - Indicates whether the user can interrupt a speech prompt from the bot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageSelectionStrategy

        PromptSpecification.Builder messageSelectionStrategy​(String messageSelectionStrategy)

        Indicates how a message is selected from a message group among retries.

        Parameters:
        messageSelectionStrategy - Indicates how a message is selected from a message group among retries.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageSelectionStrategy, MessageSelectionStrategy

      • promptAttemptsSpecificationWithStrings

        PromptSpecification.Builder promptAttemptsSpecificationWithStrings​(Map<String,​PromptAttemptSpecification> promptAttemptsSpecification)

        Specifies the advanced settings on each attempt of the prompt.

        Parameters:
        promptAttemptsSpecification - Specifies the advanced settings on each attempt of the prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promptAttemptsSpecification

        PromptSpecification.Builder promptAttemptsSpecification​(Map<PromptAttempt,​PromptAttemptSpecification> promptAttemptsSpecification)

        Specifies the advanced settings on each attempt of the prompt.

        Parameters:
        promptAttemptsSpecification - Specifies the advanced settings on each attempt of the prompt.
        Returns:
        Returns a reference to this object so that method calls can be chained together.