Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

studypal

Have a conversation about any article on the web

studypal is a fast conversational AI built using Daily or SmallWebRTC for real-time media transport, Deepgram for speech-to-text, OpenAI for LLM inference, and Cartesia for text-to-speech. Everything is orchestrated together (VAD -> STT -> LLM -> TTS) using Pipecat.

Supported Content Sources

studypal can extract and discuss content from:

  • Wikipedia articles - Any Wikipedia URL in any language

    • Example: https://en.wikipedia.org/wiki/Artificial_intelligence
    • Example: https://es.wikipedia.org/wiki/Inteligencia_artificial
  • arXiv papers - Academic papers from arXiv.org

    • Example: https://arxiv.org/abs/1706.03762 (Attention Is All You Need)
    • Example: https://arxiv.org/pdf/1706.03762.pdf (PDF URLs also work)

Note: Content is automatically truncated to 10,000 tokens to fit within the LLM context window.

Setup

  1. Clone the repository

  2. Copy env.example to a .env file and add API keys

  3. Install the required packages: uv sync

  4. Run from your command line:

    • Daily: uv run bot.py -t daily
    • SmallWebRTC: uv run bot.py
  5. Connect using your browser by clicking on the link generated in the console

  6. When prompted, enter a Wikipedia or arXiv URL you'd like to discuss

Example Usage

$ uv run bot.py
Enter the URL of the article you would like to talk about: https://en.wikipedia.org/wiki/Python_(programming_language)

The bot will then be ready to answer questions and discuss the article content with you!