Commands

$ npm test # run tests with Jest
$ npm run coverage # run tests with coverage and open it on browser
$ npm run lint # lint code
$ npm run docs # generate docs
$ npm run build # generate docs and transpile code

API

Table of Contents

• DialogProcessor
  • Parameters
  • fallthrough
    • Parameters
  • filterIntentWithNLUThreshold
    • Parameters
  • getStateIDafterFallthrough
    • Parameters
  • getAllTransitionIntentsAfterFallthrough
    • Parameters
  • getAllStateMessages
  • getMostProbableTransition
    • Parameters
  • goToState
    • Parameters
  • isTransitionCompatibleWithSlots
    • Parameters
  • processText
    • Parameters
  • resetToInitialState
  • rewindToState
    • Parameters
  • registerFeatures
    • Parameters
  • stateToMessages
    • Parameters
  • transition
    • Parameters
• initDialogs
  • Parameters

DialogProcessor

Dialog engine

Parameters

• currentStateID
• slots

fallthrough

Falltrough the dialogs until a branching is found. This function does not update the internal state. It just return the state just before the next branching

Parameters

• state State from which to start
• message List of messages to display (out parameter) (optional, default [])
• registerSlots Execute the "save slot" commands. (optional, default false)

filterIntentWithNLUThreshold

Given a list of intents, filter them according to the current state threshold. Returns a single "issues.unclear" intent when no intent is above the threshold

Parameters

• intents list of intents from the NLU

getStateIDafterFallthrough

Return the identifier of the state if a fallthrough is executed

Parameters

• stateID State from which to start

getAllTransitionIntentsAfterFallthrough

Return the list of available transition intents after fallthrough

Parameters

• stateID

getAllStateMessages

Return all the messages to display from a given state (including fallthrough)

getMostProbableTransition

Get the most probable transition from a branching state given a list of intents

Parameters

• intents a list of intents from the NLU engine.

goToState

Hard move of the state engine to a given state.

Parameters

• stateName The name of the state where to move the engine.

isTransitionCompatibleWithSlots

Find out if a state transition is compatible with the dialog engine registered slots

Parameters

• transition The transition to check

processText

Use the current registered slots to modify a state text message

Parameters

• text A state text message

resetToInitialState

Reset the engine

rewindToState

Way back machine. Rewind to a given state.

Parameters

• stateID to which user needs to rewind.

registerFeatures

The NLU can do some entity name recognition and may return a list of feature. This function saves them as slots.

Parameters

• features Features returned by the NLU engine

stateToMessages

Returns the current messages in the react-native-gifted-chat format (https://github.com/FaridSafi/react-native-gifted-chat)

Parameters

• state State for which the messages are required

transition

Execute a transition on a branching state given a list of intents

Parameters

• intents List of intents with probabilities returned by the NLU engine.

initDialogs

Initialize the dialog engine once and for all.

Parameters

• dialogsDefinition The dialog definition from lucidchart

License

MIT