Skip to content

TilmanGriesel/chipper

Repository files navigation

Logo Chipper RAG Util

Chipper gives you a web interface, CLI, and a hackable, simple architecture for embedding pipelines, document chunking, web scraping, and query workflows. Built with Haystack, Ollama, Docker, Tailwind, and ElasticSearch, it runs locally or scales as a Dockerized service.

This project started as a way to help my girlfriend with her new book. The idea was to use local RAG and LLMs to ask questions about characters and explore creative possibilities, all without sharing proprietary details or your own book with cloud services like ChatGPT. What began as a bunch of scripts is now growing into a fully dockerized service architecture.

If you like what you see, leaving a star would be sweet and will help more people discover Chipper!

Features

  • Build a powerful knowledge base using ElasticSearch embeddings.
  • Automatically split documents via Haystack.
  • Scrape content from web sources.
  • Transcribe audio files into text.
  • Access via a user-friendly CLI or web client interface.
  • Deploy effortlessly using Docker.

Installation and Setup

Visit the Chipper project website for detailed setup instructions.

Note: This is just a research project, so it's not built for production.

Philosophy

At the heart of this project lies my passion for education and exploration. I believe in creating tools that are both approachable for beginners and helpful for experts. My goal is to offer you a well-thought-out service architecture, and a stepping stone for those eager to learn and innovate.

This project wants to be more than just a technical foundation, for educators, it provides a framework to teach AI concepts in a manageable and practical way. For explorers, tinkerers and companies, it offers a playground where you can experiment, iterate, and build upon a versatile platform.

Feel free to improve, fork, copy, share or expand this project. Contributions are always very welcome!

Demo

Chipper RAG Util Demo Browser

Roadmap

  • Basic functionality
  • CLI
  • Web UI
  • Docker
  • Improved Web UI with better mobile support
  • Improve linting and formatting
  • React based web app
  • CI test
  • Docker Hub registry images
  • Smart document chunking and embedding

Special Thanks

A huge shoutout and heartfelt thanks to all the incredible projects that make Chipper possible:

  • Haystack for providing the foundation for embedding and retrieval.
  • Ollama for their amazing models and project.
  • Elastic and Elasticvue for powering fast and efficient data retrieval.
  • Docker for simplifying deployment and making setup a breeze.
  • VitePress, just the most lovely static site generator.

These projects are the backbone of Chipper, and their contributions inspire endless possibilities.


Be sure to visit the Chipper project website for detailed setup instructions and more information.