Scheduling Reminders¶

Scheduling the reminder¶

The reminder will be scheduled when it is returned as an event after executing an action. Here is an example implementation for our action_confirm_booking:

from rasa_core.actions import Action
from rasa_core.events import Reminder
import datetime
from datetime import timedelta

class ActionConfirmBooking(Action):
    def name(self):
        return "confirm_booking"

    def run(self, dispatcher, tracker, domain):
        dispatcher.utter_message("Do you want to confirm your booking at Papi's pizza?")
        return [Reminder("action_booking_reminder", datetime.now() + timedelta(hours=5)]

This action schedules a reminder in 5 hours. The reminder will trigger the action action_booking_reminder.

What happens when the reminder is triggered¶

First of all, the action whose name was part of the reminder will get executed. An implementation for our example could look like this:

from rasa_core.actions import Action
from rasa_core.events import Reminder


class ActionBookingReminder(Action):
    def name(self):
        return "booking_reminder"

    def run(self, dispatcher, tracker, domain):
        dispatcher.utter_message("You have an unconfirmed booking at Papi's pizza, would you like to confirm it?")
        return []

By default, reminders will be cancelled if the user sends any message to the bot before the scheduled reminder time. If you do not want that to happen you need so set the kill_on_user_message flag when creating the reminder: Reminder("action_booking_reminder", datetime.now() + timedelta(hours=5), kill_on_user_message=False)

After the action is triggered, the action execution continues as though the user had sent the bot an empty message. So in our stories we need to define what happens after the reminder was executed:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

## book a restaurant
* _start_booking
    - action_suggest_restaurant
* _select_restaurant[name=Papi's Pizza Place]
    - action_confirm_booking

## reminder_confirm
    - action_booking_reminder
* _agree
    - action_book_restaurant

## reminder_cancel
    - action_booking_reminder
* _deny
    - action_cancel_booking

We have added two stories: One where the user agrees to the message we sent in the reminder and one where they decide to cancel the booking.