abeljohny/zoe

Natural Language Calendar Management System

Zoe

Text-based Natural Language Calendar Management System

Introduction

Zoe is an NLP system for managing calendar operations, specifically scheduling, canceling, and searching for events while handling casual small talk through the command line.

Working with Zoe

Follow along Zoe's prompts and experiment using the code to understand its usage.

See below for a cheatsheet on using Zoe with single-turn prompts.

Booking Calendar Events

Sample query: Book "meeting with Tim" at 10 tomorrow

Sample query: Book "meeting with Jony" on 01/29/2023 at 10pm

note: event names are in quotes

Searching Calendar Events

Sample query: Show all my events for tomorrow / Show tomorrow

Cancelling Calendar Events

Sample query: Cancel "meeting with Jony" on 01/29/2024 at 10pm

note: event names are in quotes

Extensibility

Zoe's capabilities are extensible. New intents are introduced through the following steps:

1. Create an intent set in the intent_sets directory with the intents’ name as the filename with the associated prompts as its file contents.
2. Logic for intent sets are processed using intent handlers and stored in the intent_handlers directory. Create an intent handler for your intent set.
3. Retrain Zoe's classifier using the reindex flag.

High-level Architecture (UML)

License

Zoe is GPL-2 licensed.