Jargone

Simplifying Jargon, Enabling Collaboration
Jargone is an AI-powered browser extension that provides real-time explanations for complex technical or domain-specific terms. It bridges communication gaps between cross-functional teams by offering clear, contextual definitions right where users need them.

🎥 Watch Demo

📝 See Presentation

For proof-of-concept, we use OpenAI’s API. However, we prioritize privacy and security: for enterprise deployment, Jargone can be configured with on-premise LLMs such as LLaMA, ensuring all company data remains secure within your infrastructure.

---

✨ Key Features

• 🔍 Instant Jargon Explanation: Select any text on a webpage to receive a real-time, context-aware explanation. The tool also integrates company-provided documents, delivering tailored responses.
• 🧑‍💼 Contextual Personalization: Customize explanations based on your role and preferred depth of detail.
• 📚 Search History: Review previous explanations for reference.
• ⚙️ Configurable Backend: Swap between public APIs and private LLMs (like LLaMA) for full control over data privacy.

---

🛠️ Tech Stack

Built with:

• Python – backend logic and API
• FastAPI – backend web framework
• OpenAI API – proof-of-concept LLM
• Docker – containerized architecture
• RAG – retrieval-augmented generation pattern
• Qdrant – vector similarity search engine
• PostgreSQL – structured data storage
• JavaScript – frontend/browser extension
• LLaMA (optional) – self-hosted LLM alternative for enterprise

---

🧪 Installation Guide

Prerequisites

• Ensure Docker and Docker Compose are installed
• A Chromium-based browser (e.g., Chrome) is required
• Node.js and npm (optional, only necessary if you intend to modify or build the frontend)

Backend Setup

1. Clone the repository:

   git clone https://github.com/yourusername/jargone.git

2. Spin up the required services (MySQL, Qdrant, and RAG API server) using Docker Compose After cloning the repository, navigate to the project folder and run Docker Compose to build and start the necessary services:

cd jargone
docker-compose up --build

This will start the following services:

• MySQL: store entities and their explanations
• Qdrant: for semantic vector search
• FastAPI server: for serving the explanation API using RAG architecture

Frontend Setup (Browser Extension)

1. Open Chrome and go to chrome://extensions/
2. Turn on Developer Mode in the top-right corner
3. Click Load unpacked and choose the cloned repository directory
4. The Jargone extension icon should now appear in your browser toolbar

---

🚀 Usage

1. Highlight any word or phrase on a webpage
2. Click the Jargone extension icon
3. View the explanation instantly in the popup

Extension Tabs

• Results – Explanation for current selection
• History – Access previously viewed definitions
• Profile – Set your role and explanation detail level

---

🔌 Backend API

Jargone communicates with the backend through a REST API.

Endpoint:

POST http://localhost:8000/explain

Request Body:

{
  "text": "Selected jargon term",
  "explanationLevel": "basic",
  "userRole": "Marketing Manager",
  "additionalContext": "I'm new to the tech industry and unfamiliar with infrastructure concepts."
}

---

🔐 Data Privacy

Jargone was designed with data privacy in mind:

• The proof-of-concept uses OpenAI’s API for LLM capabilities.
• For business use, this can be replaced with self-hosted models such as LLaMA, ensuring all sensitive documents and user queries stay on-premise.

---

📍 Project Status

• ✅ Functional prototype complete
• 🚀 Preparing for production deployment
• 🧩 Looking for contributors and feedback

---

🤝 Contributing

We welcome contributions! If you'd like to submit a feature, improvement, or fix, please open an issue or a pull request.