io.spokestack.spokestack.dialogue.policy

Class Model

java.lang.Object

io.spokestack.spokestack.dialogue.policy.Model

public final class Model
extends Object

Classes used for representing the pieces of a rule-based dialogue policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Model.Feature A feature represents the app operating on data outside the control of the dialogue policy.
static class	Model.Frame A conversation frame is roughly analogous to a screen/Activity in an application.
static class	Model.Node A node represents a specific conversational state within a broader Model.Frame.
static class	Model.Rule A rule alters the conversation flow based on the data available to the policy at runtime.

Constructor Summary

Constructors

Constructor and Description
Model() No-arg constructor used by Gson deserialization.

Method Summary

Modifier and Type	Method and Description
String	baseNode(String frameName) Get the name of the base/main Model.Node for a given frame.
io.spokestack.spokestack.dialogue.policy.Model.AbstractNode	fetchNode(String nodeId) Fetch a node by ID.
Model.Node	findErrorNode(io.spokestack.spokestack.dialogue.policy.UserTurn userTurn, String nodeId) Locate the most specific error node relevant to the user's request.
Model.Node	findSpecialNode(io.spokestack.spokestack.dialogue.policy.UserTurn userTurn, String nodeId) Locate the most specific node relevant to the user's request.
Model.Feature	lookupFeature(String featureName, String currentNode) Look up a feature given its name.
Model.Node	lookupNode(String nodeName) Look up a node given its name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Model

public Model()

No-arg constructor used by Gson deserialization.

Method Detail

findSpecialNode

public Model.Node findSpecialNode(io.spokestack.spokestack.dialogue.policy.UserTurn userTurn,
                                  String nodeId)

Locate the most specific node relevant to the user's request.

Currently, help and inform dialogue acts route the user to frames whose names match the act, looking for nodes within those frames in the following descending order of specificity:

1. <frame>.<node_or_feature_name>.<slot_name>
2. <frame>.<node_or_feature_name>
3. <frame>.__base__

In the above examples, node_or_feature_name refers to the user's conversation state at the time of userTurn. slot_name is currently only relevant to the inform act but may be expanded in the future.

Parameters:

userTurn - The user turn that calls for a special node.

nodeId - The user's current node in the conversation.

Returns:

The special node most relevant to the user's request.

findErrorNode

public Model.Node findErrorNode(io.spokestack.spokestack.dialogue.policy.UserTurn userTurn,
                                String nodeId)

Locate the most specific error node relevant to the user's request.

This method acts much like findSpecialNode, looking up nodes on the error frame in the following descending order of specificity:

1. error.<intent_name>.<node_or_feature_name>
2. error.<intent_name>
3. error.__base__

In the above examples, node_or_feature_name refers to the user's conversation state at the time of userTurn. intent_name refers to the user's intent.

Parameters:

userTurn - The user turn that calls for a special node.

nodeId - The user's current node in the conversation.

Returns:

The error node most relevant to the user's request.

baseNode

public String baseNode(String frameName)

Get the name of the base/main Model.Node for a given frame.

Parameters:

frameName - The name of the frame.

Returns:

The name of frameName's base node.

lookupNode

public Model.Node lookupNode(@NonNull
                             String nodeName)

Look up a node given its name.

Parameters:

nodeName - The name of the node to fetch. May be in frame.node format or frame format for a frame's base node.

Returns:

The specified node, or null if no such node exists.

lookupFeature

public Model.Feature lookupFeature(String featureName,
                                   String currentNode)

Look up a feature given its name.

Parameters:

featureName - The name of the feature to fetch.

currentNode - The ID of the user's current node, to aid in disambiguation.

Returns:

The specified feature, or null if no such feature exists.

fetchNode

public io.spokestack.spokestack.dialogue.policy.Model.AbstractNode fetchNode(String nodeId)

Fetch a node by ID. "Node" here is used in an abstract sense to refer to the fields that features and nodes contained by frames have in common.

Parameters:

nodeId - The ID of the node to retrieve.

Returns:

The specified node, either a feature or an actual node.