VocalDocs

StatechartStateInput

One state of a region: its kind, the Agent bound to it, its instructions, the Tools it offers, the slots the model may fill, its question set, its limits, its entry and exit actions and its timers.

An object with 15 fields.

Fields

afterarray of StateTimerInput
Timers started when the state is entered and cancelled when it is left.
The Agent that holds the conversation in an agent, action or final state. Defaults to self.
The question set the decision lane runs on each completed caller utterance in this state.
exit_eventsarray of MachineEventName
Events that must each have a transition out of this state; checked at publish.
fillarray of SlotName
The slots the model may write in this state through set_slot. Each must be declared writable by model.
Defaults to full.
instructionsstring
Instructions added to the model request while this state is active, written in the template language.
kindStateKindrequired
on_enterarray of MachineActionInput
Actions run when the state is entered.
on_exitarray of MachineActionInput
Actions run when the state is left.
ruleset_idstring
For an evaluate state only: a Ruleset that chooses its transition. Not available yet and refused with capability_not_available; use the guards of its transitions instead.
toolsarray of ToolName
The Tools offered in this state, a subset of the bound Agent's Tools; a Tool outside that set is refused with statechart_capability_mismatch. All of them when omitted, none when empty.
Defaults to inherit.