io.spokestack.spokestack.dialogue

Class Prompt.Builder

java.lang.Object

io.spokestack.spokestack.dialogue.Prompt.Builder

Enclosing class:

Prompt

public static final class Prompt.Builder
extends Object

Prompt builder API.

Constructor Summary

Constructors

Constructor and Description
Builder(String promptId, String textReply) Create a new prompt builder with the minimal set of required data.

Method Summary

Modifier and Type	Method and Description
Prompt	build()
Prompt.Builder	endsConversation() Signals that the prompt to be built should end the conversation with the user.
Prompt.Builder	withProposal(Proposal prop) Add a proposal to the current prompt.
Prompt.Builder	withReprompts(List<Prompt> prompts) Specify reprompts for the current prompt.
Prompt.Builder	withVoice(String voiceReply) Add a reply template formatted for TTS synthesis to the current prompt.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NonNull
               String promptId,
               @NonNull
               String textReply)

Create a new prompt builder with the minimal set of required data.

Parameters:

promptId - The prompt's ID.

textReply - A reply template formatted for print.

Method Detail

endsConversation

public Prompt.Builder endsConversation()

Signals that the prompt to be built should end the conversation with the user.

Returns:

the updated builder

withVoice

public Prompt.Builder withVoice(@NonNull
                                String voiceReply)

Add a reply template formatted for TTS synthesis to the current prompt.

Parameters:

voiceReply - The voice prompt to be added.

Returns:

the updated builder

withProposal

public Prompt.Builder withProposal(@NonNull
                                   Proposal prop)

Add a proposal to the current prompt.

Parameters:

prop - The proposal to be added.

Returns:

the updated builder

withReprompts

public Prompt.Builder withReprompts(@NonNull
                                    List<Prompt> prompts)

Specify reprompts for the current prompt.

Parameters:

prompts - The reprompts to attach.

Returns:

the updated builder

build

public Prompt build()

Returns:

a complete prompt created from the current builder state.