Metadata-Version: 2.4
Name: synapse-studio
Version: 0.1.1
Summary: Visual GUI front-end for synapse-core
Project-URL: Homepage, https://github.com/adm-crow/synapse-studio
Project-URL: Repository, https://github.com/adm-crow/synapse-studio
Project-URL: Issues, https://github.com/adm-crow/synapse-studio/issues
License: MIT License
        
        Copyright (c) 2025 synapse-studio contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: gui,llm,nicegui,rag,synapse
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Requires-Dist: nicegui[native]>=1.4
Requires-Dist: synapse-core>=1.1.1
Description-Content-Type: text/markdown

<div align="center">
  <img src="https://raw.githubusercontent.com/adm-crow/synapse-studio/main/synapse_studio/static/favicon.svg" alt="Synapse Studio" width="90" /><br/><br/>

  <h1>Synapse Studio</h1>
  <p><strong>Native desktop GUI for <a href="https://github.com/adm-crow/synapse">synapse-core</a> — ingest documents, search semantically, chat with your data.</strong></p>

![Python](https://img.shields.io/badge/python-3.11%2B-blue?style=flat-square&logo=python&logoColor=white)
![GitHub License](https://img.shields.io/github/license/adm-crow/synapse-studio?style=flat-square&logo=github&logoColor=white)
![GitHub release date](https://img.shields.io/github/release-date/adm-crow/synapse-studio?display_date=published_at&style=flat-square&logo=github&logoColor=white)

</div>

---

No cloud, no browser, no infrastructure. Synapse Studio runs entirely on your machine as a native desktop window — point it at a folder, ingest, and start searching or chatting with your documents.

| | |
|---|---|
| **Query** | Semantic search with score filtering and result cards |
| **Chat** | RAG-powered AI chat using your documents as context |
| **Collections** | Browse, inspect, and manage vector collections |
| **Ingest** | Index a local folder with real-time progress and model mismatch detection |
| **Settings** | Provider, model, API key, embedding model, theme, dark mode |

---

## Screenshots

<div align="center">
  <img src="docs/screenshots/query.png" alt="Synapse Studio — Query tab" width="90%" />
</div>

---

## Install

```bash
pip install synapse-studio
```

> [!NOTE]
> To support additional file formats (`.html` `.pptx` `.xlsx` `.epub` `.odt`), install the `formats` extra of synapse-core:
> ```bash
> pip install "synapse-core[formats]"
> ```

---

## Usage

```bash
synapse-studio
```

The app opens as a native desktop window. On first launch, go to **Settings** and configure:

- **DB path** — where your vector database is stored (default: `./synapse_db`)
- **Embedding model** — any [sentence-transformers](https://huggingface.co/models?library=sentence-transformers) model (default: `all-MiniLM-L6-v2`)
- **AI provider / model / API key** — required for the Chat tab (Anthropic or OpenAI)

Then open **Ingest**, pick a folder, and click **Start Ingest**. Use **Query** or **Chat** once ingestion is complete.

---

## Supported file formats

`.txt` `.md` `.csv` `.pdf` `.docx` `.json` `.jsonl` `.html`* `.pptx`* `.xlsx`* `.epub`* `.odt`*

*requires `synapse-core[formats]`

---

## Embedding models

Any model from [Hugging Face sentence-transformers](https://huggingface.co/models?library=sentence-transformers&sort=downloads) works — paste the model name directly into **Settings → Embedding model**.
See the [MTEB Leaderboard](https://huggingface.co/spaces/mteb/leaderboard) to compare quality.

| Model | Dims | Notes |
|---|---|---|
| `all-MiniLM-L6-v2` | 384 | Default — fast, lightweight |
| `BAAI/bge-base-en-v1.5` | 768 | Better quality, good speed |
| `BAAI/bge-large-en-v1.5` | 1024 | Best quality, slower |
| `paraphrase-multilingual-MiniLM-L12-v2` | 384 | Multilingual (50+ languages) |

> [!WARNING]
> Each collection is tied to the model used at ingest time. Do not mix models within the same collection — Synapse Studio will warn you if a mismatch is detected before ingesting.

---

## Configuration

Settings are saved to `synapse.toml` in the working directory. This file is excluded from version control (`.gitignore`) as it contains local paths and API keys.

---

## Requirements

- Python 3.11+
- [synapse-core](https://github.com/adm-crow/synapse) ≥ 1.1.1 (installed automatically)

---

<div align="center">
  <sub>
    <a href="https://github.com/adm-crow/synapse">synapse-core</a> ·
    <a href="https://pypi.org/project/synapse-core/">PyPI</a> ·
    <a href="LICENSE">MIT</a>
  </sub>
</div>
