Sapphire

An assistant for managing and talking to your files.

Features • Usage • Roadmap

Features

The app contains two agents: the Wizard and the Witch. It's mainly for personal use with Obsidian for college...

🦉 Wizard 🦉

Abilities

• Request an action to be done to your current directory. The wizard will execute the corresponding command for you.
• Examples of requests:
  • List the files that were created after September 22, 2022.
  • Replace all instances of "witch" in ./sorcery with "wizard".
  • etc.

🔮 Witch 🔮

Abilities

• Ask the witch a question about the contents of the files in your current directory. The witch will intelligently answer your question using the knowledge obtained from your files.
• The Chroma vector store is cached locally and configured to be recalculated if it's a new day.
• Note: as of now, only markdown features are supported.
• Examples of questions (given that the directory contains notes about computational photography):
  • What did the professor say are the tradeoffs between Lagrangian vs Eulerian motion magnification in videos?
  • How does Laplacian pyramid blending work?
  • Which of the following properties apply to affine transformations? [...]
  • etc.

Usage

1. Clone the repo
2. Store your Open AI key as an environment variable called OPENAI_API_KEY
3. Add an alias for /src/main.py to your .bashrc so that you can call Sapphire from any directory
4. For me, this looked like alias sapphire='python [my_path]/sapphire/src/main.py'
5. cd into the cloned repo and run pip install -r requirements.txt

Roadmap

• Ingest images
• Support Latex