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

Interface Prompt.Builder

    • Method Detail

      • messages

        Prompt.Builder messages​(Collection<Message> messages)

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        Parameters:
        messages - An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messages

        Prompt.Builder messages​(Message... messages)

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        Parameters:
        messages - An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messages

        Prompt.Builder messages​(Consumer<Message.Builder>... messages)

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

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

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

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

      • maxAttempts

        Prompt.Builder maxAttempts​(Integer maxAttempts)

        The number of times to prompt the user for information.

        Parameters:
        maxAttempts - The number of times to prompt the user for information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • responseCard

        Prompt.Builder responseCard​(String responseCard)

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        Parameters:
        responseCard - A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.
        Returns:
        Returns a reference to this object so that method calls can be chained together.