io.spokestack.spokestack.dialogue

Class DialogueManager.Builder

java.lang.Object

io.spokestack.spokestack.dialogue.DialogueManager.Builder

Enclosing class:

DialogueManager

public static class DialogueManager.Builder
extends Object

Dialogue manager builder API.

Constructor Summary

Constructors

Constructor and Description
Builder() Create a new dialogue manager builder with a default configuration.
Builder(SpeechConfig speechConfig) Create a new dialogue manager builder with the supplied configuration.

Method Summary

Modifier and Type	Method and Description
DialogueManager.Builder	addListener(DialogueListener listener) Add a listener to receive dialogue events and related log messages.
DialogueManager	build() Build a dialogue manager that reflects the current builder state.
boolean	hasPolicy()
DialogueManager.Builder	setProperty(String key, Object value) Sets a configuration value.
DialogueManager.Builder	withDataStore(ConversationData dataStore) Specify the data store to use for conversation data.
DialogueManager.Builder	withDialoguePolicy(String policyClass) Specify the dialogue policy for the manager to use.
DialogueManager.Builder	withPolicyFile(String file) Specify the path to the JSON file containing a Spokestack dialogue policy for the manager to use.
DialogueManager.Builder	withTraceLevel(int level) Specify the maximum level of log messages to be delivered to listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a new dialogue manager builder with a default configuration.

Builder

public Builder(SpeechConfig speechConfig)

Create a new dialogue manager builder with the supplied configuration.

Parameters:

speechConfig - The configuration to use for dialogue management.

Method Detail

setProperty

public DialogueManager.Builder setProperty(String key,
                                           Object value)

Sets a configuration value.

Parameters:

key - configuration property name

value - property value

Returns:

the updated builder state

withPolicyFile

public DialogueManager.Builder withPolicyFile(String file)

Specify the path to the JSON file containing a Spokestack dialogue policy for the manager to use.

This is a convenience method for setProperty("dialogue-policy-file", file).

Parameters:

file - Path to a dialogue configuration file.

Returns:

the updated builder state

withDialoguePolicy

public DialogueManager.Builder withDialoguePolicy(String policyClass)

Specify the dialogue policy for the manager to use.

This is a convenience method for setProperty("dialogue-policy-class", policyClass).

Parameters:

policyClass - The name of the class containing the dialogue policy to use.

Returns:

the updated builder state

hasPolicy

public boolean hasPolicy()

Returns:

whether this builder has a dialogue policy enabled via class or JSON file.

withDataStore

public DialogueManager.Builder withDataStore(ConversationData dataStore)

Specify the data store to use for conversation data.

Parameters:

dataStore - The data store to use for the conversation.

Returns:

the updated builder state

withTraceLevel

public DialogueManager.Builder withTraceLevel(int level)

Specify the maximum level of log messages to be delivered to listeners.

Parameters:

level - The maximum log level to deliver.

Returns:

the updated builder state

addListener

public DialogueManager.Builder addListener(DialogueListener listener)

Add a listener to receive dialogue events and related log messages.

Parameters:

listener - A dialogue listener.

Returns:

the updated builder state

build

public DialogueManager build()
                      throws Exception

Build a dialogue manager that reflects the current builder state.

Returns:

A dialogue manager that reflects the current builder state.

Throws:

Exception - if there is an error building the manager.