io.spokestack.spokestack.rasa

Class RasaDialoguePolicy

java.lang.Object

io.spokestack.spokestack.rasa.RasaDialoguePolicy

All Implemented Interfaces:

DialoguePolicy

public final class RasaDialoguePolicy
extends Object
implements DialoguePolicy

A dialogue policy that examines the response from a Rasa Open Source server retrieved by a RasaOpenSourceNLU component and dispatches events based on its contents.

A text response is dispatched as a PROMPT event, and an image is dispatched as an ACTION event with an appAction of "displayImage" and a systemPrompt containing the image URL.

Intents that do not match the one produced by RasaOpenSourceNLU are not supported and will result in ERROR events.

Constructor Summary

Constructors

Constructor and Description
RasaDialoguePolicy(SpeechConfig speechConfig) Create a new dialogue policy for handling responses from Rasa Open Source.

Method Summary

Modifier and Type	Method and Description
void	completeTurn(boolean success, ConversationData conversationData, DialogueDispatcher eventDispatcher) Complete the pending user turn.
String	dump(ConversationData conversationData) Store the internal state of the dialogue policy in the specified data store for cross-session persistence.
void	handleTurn(NLUResult userTurn, ConversationData conversationData, DialogueDispatcher eventDispatcher) Process a user turn and return a relevant response.
void	load(String state, ConversationData conversationData) Load previously serialized internal state.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasaDialoguePolicy

public RasaDialoguePolicy(SpeechConfig speechConfig)

Create a new dialogue policy for handling responses from Rasa Open Source.

Parameters:

speechConfig - configuration properties for this policy.

Method Detail

dump

public String dump(ConversationData conversationData)

Description copied from interface: DialoguePolicy

Store the internal state of the dialogue policy in the specified data store for cross-session persistence.

Specified by:

dump in interface DialoguePolicy

Parameters:

conversationData - The data store where policy state should be saved.

Returns:

The policy state that was dumped.

load

public void load(String state,
                 ConversationData conversationData)

Description copied from interface: DialoguePolicy

Load previously serialized internal state.

Specified by:

load in interface DialoguePolicy

Parameters:

state - Policy state serialized using dump().

conversationData - The data store where any relevant policy state should be loaded.

handleTurn

public void handleTurn(NLUResult userTurn,
                       ConversationData conversationData,
                       DialogueDispatcher eventDispatcher)

Description copied from interface: DialoguePolicy

Process a user turn and return a relevant response.

Specified by:

handleTurn in interface DialoguePolicy

Parameters:

userTurn - The user input as determined by the NLU component.

conversationData - Conversation data used to resolve and prepare a response.

eventDispatcher - Dispatcher used to notify listeners of dialogue events.

completeTurn

public void completeTurn(boolean success,
                         ConversationData conversationData,
                         DialogueDispatcher eventDispatcher)

Description copied from interface: DialoguePolicy

Complete the pending user turn.

This method should be called after any actions or data retrieval pending in the app are completed.

Specified by:

completeTurn in interface DialoguePolicy

Parameters:

success - true if the user's request/desired action was fulfilled successfully; false otherwise.

conversationData - Conversation data used to resolve and prepare a response.

eventDispatcher - Dispatcher used to notify listeners of dialogue