Intent Layers
WARNING: Skills using these features might not play well with HiveMind due to shared state across satellites
Managing Intents
Sometimes you might want to manually enable or disable an intent, in OVOSSkills you can do this explicitly to create stateful interactions
class RotatingIntentsSkill(OVOSSkill):
def initialize(self):
# NOTE: this must be done in initialize, not in __init__
self.disable_intent("B.intent")
self.disable_intent("C.intent")
@intent_handler("A.intent")
def handle_A_intent(self, message):
# do stuff
self.enable_intent("B.intent")
self.disable_intent("A.intent")
@intent_handler("B.intent")
def handle_B_intent(self, message):
# do stuff
self.enable_intent("C.intent")
self.disable_intent("B.intent")
@intent_handler("C.intent")
def handle_C_intent(self, message):
# do stuff
self.enable_intent("A.intent")
self.disable_intent("C.intent")
NOTE: Intent states are currently shared across Sessions
State Machines
Another utils provided by ovos-workshop is IntentLayers, to manage groups of intent together
IntentLayers lend themselves well to implement state machines.
The Manual way
In this example we implement the Konami Code, doing everything the manual way instead of using decorators
class KonamiCodeSkill(OVOSSkill):
def initialize(self):
self.counter = 0
self.top_fails = 3
up_intent = IntentBuilder('KonamiUpIntent').require("KonamiUpKeyword").build()
down_intent = IntentBuilder('KonamiDownIntent').require("KonamiDownKeyword").build()
left_intent = IntentBuilder('KonamiLeftIntent').require("KonamiLeftKeyword").build()
right_intent = IntentBuilder('KonamiRightIntent').require("KonamiRightKeyword").build()
b_intent = IntentBuilder('KonamiBIntent').require("KonamiBKeyword").build()
a_intent = IntentBuilder('KonamiAIntent').require("KonamiAKeyword").build()
self.register_intent(up_intent, self.handle_up_intent)
self.register_intent(down_intent, self.handle_down_intent)
self.register_intent(left_intent, self.handle_left_intent)
self.register_intent(right_intent, self.handle_right_intent)
self.register_intent(b_intent, self.handle_b_intent)
self.register_intent(a_intent, self.handle_a_intent)
def build_intent_layers(self):
self.intent_layers.update_layer("up1", ["KonamiUpIntent"])
self.intent_layers.update_layer("up2", ["KonamiUpIntent"])
self.intent_layers.update_layer("down1", ["KonamiDownIntent"])
self.intent_layers.update_layer("down2", ["KonamiDownIntent"])
self.intent_layers.update_layer("left1", ["KonamiLeftIntent"])
self.intent_layers.update_layer("right1",["KonamiRightIntent"])
self.intent_layers.update_layer("left2", ["KonamiLeftIntent"])
self.intent_layers.update_layer("right2",["KonamiRightIntent"])
self.intent_layers.update_layer("B",["KonamiBIntent"])
self.intent_layers.update_layer("A",["KonamiAIntent"])
self.intent_layers.activate_layer("up1")
def reset(self):
self.active = False
self.counter = 0
self.intent_layers.disable()
self.intent_layers.activate_layer("up1")
def handle_up_intent(self, message):
if self.intent_layers.is_active("up1"):
self.intent_layers.deactivate_layer("up1")
self.intent_layers.activate_layer("up2")
else:
self.intent_layers.activate_layer("down1")
self.intent_layers.deactivate_layer("up2")
self.acknowledge()
def handle_down_intent(self, message):
if self.intent_layers.is_active("down1"):
self.intent_layers.deactivate_layer("down1")
self.intent_layers.activate_layer("down2")
else:
self.intent_layers.activate_layer("left1")
self.intent_layers.deactivate_layer("down2")
self.acknowledge()
def handle_left_intent(self, message):
if self.intent_layers.is_active("left1"):
self.intent_layers.deactivate_layer("left1")
self.intent_layers.activate_layer("right1")
else:
self.intent_layers.deactivate_layer("left2")
self.intent_layers.activate_layer("right2")
self.acknowledge()
def handle_right_intent(self, message):
if self.intent_layers.is_active("right1"):
self.intent_layers.deactivate_layer("right1")
self.intent_layers.activate_layer("left2")
else:
self.intent_layers.activate_layer("B")
self.intent_layers.deactivate_layer("right2")
self.acknowledge()
def handle_b_intent(self, message):
self.intent_layers.activate_layer("A")
self.intent_layers.deactivate_layer("B")
self.acknowledge()
def handle_a_intent(self, message):
self.play_audio("power_up.mp3")
self.reset()
def stop(self):
if self.active:
self.reset()
def converse(self, message):
if self.active:
if not any(self.voc_match(utt, kw) for kw in ["KonamiUpKeyword",
"KonamiDownKeyword",
"KonamiLeftKeyword",
"KonamiRightKeyword",
"KonamiBKeyword",
"KonamiAKeyword"]):
self.counter += 1
if self.counter > self.top_fails:
self.speak("Wrong cheat code")
self.reset()
else:
self.speak("Wrong! Try again")
return True
return False
Decorators
When you have many complex chained intents IntentLayers often makes your life easier, a layer is a named group of intents that you can manage at once.
Slightly more complex than the previous example, we may want to offer several "forks" on the intent execution, enabling different intent groups depending on previous interactions
skill-moon-game is an example full voice game implemented this way
An excerpt from the game to illustrate usage of IntentLayer decorators
NOTE: IntentLayers do not yet support Session, in this example all voice satellites would join the game
from ovos_workshop.skills.decorators import layer_intent, enables_layer, \
disables_layer, resets_layers
class Apollo11GameSkill(OVOSSkill):
def initialize(self):
# start with all game states disabled
self.intent_layers.disable()
@intent_handler(IntentBuilder("StartApollo11Intent"). \
optionally("startKeyword"). \
require("MoonGameKeyword"))
def handle_start_intent(self, message=None):
if not self.playing:
self.playing = True
self.speak_dialog("start.game")
self.handle_intro()
else:
self.speak_dialog("already.started")
@layer_intent(IntentBuilder("StopApollo11Intent"). \
require("stopKeyword"). \
optionally("MoonGameKeyword"),
layer_name="stop_game")
@resets_layers()
def handle_game_over(self, message=None):
if self.playing:
self.speak_dialog("stop.game")
@enables_layer(layer_name="guard")
@enables_layer(layer_name="stop_game")
def handle_intro(self):
self.speak_dialog("reach_gate")
self.speak_dialog("guard")
self.speak_dialog("present_id", expect_response=True)
@layer_intent(IntentBuilder("Yes1Apollo11Intent").require("yesKeyword"),
layer_name="guard")
def handle_yes1(self, message=None):
self.speak_dialog("guard_yes")
self.briefing_question1()
@layer_intent(IntentBuilder("No1Apollo11Intent").require("noKeyword"),
layer_name="guard")
@enables_layer(layer_name="guard2")
@disables_layer(layer_name="guard")
def handle_no1(self, message=None):
self.speak_dialog("guard_no")
self.speak_dialog("present_id", expect_response=True)
# (...) more intent layers
def converse(self, message):
if not self.playing:
return False
# (...)
# take corrective action when no intent matched
if self.intent_layers.is_active("guard") or \
self.intent_layers.is_active("guard2"):
self.speak_dialog("guard_dead")
self.handle_game_over()
# (...)
else:
self.speak_dialog("invalid.command", expect_response=True)
return True