This repository contains analysis code and figures for the research paper "Safe Generative Chats in a WhatsApp Intelligent Tutoring System".
In addition, we include a reference moderation system using OpenAI's Moderation API in src/student_guardrails.
This system is usable as-is, but should mostly be useful as a reference. Features:
- OpenAI Moderation API interface appropriate for both human-written and LLM-generated messages, including custom, per-category moderation thresholds.
- Banned word lists that supercede OpenAI moderation scores.
- Email alerting system using SendGrid for messages in particular categories.
- Pre-written moderation responses designed for users of the WhatsApp-based chatbot Rori.
- Unit tests that provide mocked interfaces to the OpenAI Moderation API and the SendGrid API.
If this work is useful to you in any way, please cite the corresponding paper:
Zachary Levonian, Owen Henkel. Safe Generative Chats in a WhatsApp Intelligent Tutoring System. Educational Data Mining (EDM) Workshop: Leveraging Large Language Models for Next Generation Educational Technologies. 2024.
Primary code contributor:
- Zachary Levonian ([email protected])
This project uses make and Poetry to manage and install dependencies.
On Windows, you'll need to use WSL and maybe make some other changes.
Use make install to install all needed dependencies (including the pre-commit hooks and Poetry).
You'll probably need to manually add Poetry to your PATH, e.g. by updating your .bashrc (or relevant equivalent):
export PATH="$HOME/.local/bin:$PATH"make testmake jupyterWhich really just runs poetry run jupyter lab, so feel free to customize your Jupyter experience.
poetry run <command>- Run the given command, e.g.poetry run pytestinvokes the tests.poetry add <package>- Add the given package as a dependency. Use flag-G devto add it as a development dependency.