🤖 ScriptumAI

English | Français | Español

---

🌍 English

🎯 Introduction

ScriptumAI is a private and advanced Retrieval-Augmented Generation platform designed for document ingestion, and query processing. It leverages cutting-edge machine learning and natural language processing techniques.

🏗️ Architecture

The project follows a modular architecture with distinct components for embedding, ingestion, query processing, and retrieval.

✨ Key Features

📚 Document Ingestion

• 📄 Multi-format support (text, PDF, DOCX, HTML, Markdown)
• 🔄 Chunking for efficient processing
• 💾 Storage in Chroma for fast retrieval

🔍 Query Processing

• 🧠 Uses LLM to generate relevant responses
• 📊 Context-based retrieval using cosine similarity

🖥️ User Interface

• 🛠️ Components for ingestion, queries, and search
• 📈 Dashboard for statistics and activity

🚀 Quick Start

Prerequisites

Python 3.8+ (tested with 3.13)
Flask
Streamlit
Ollama API
Chroma
pytest

Installation

# Clone the repository
git clone https://github.com/Guiss-Guiss/ScriptumAI.git

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Launch frontend
streamlit run app.py

📜 License

This project is available under a dual license:

• GNU Affero General Public License v3.0 (AGPL-3.0)
• Commercial License

See LICENSE and COMMERCIAL_LICENSE.md for details.

👥 Contributing

Please read our CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

---

🌍 Français

🎯 Introduction

ScriptumAI est une plateforme privée et avancée de Génération Augmentée par Récupération conçue pour l'ingestion de documents, la recherche sémantique et le traitement des requêtes. Elle utilise des techniques de pointe en apprentissage automatique et en traitement du langage naturel.

🏗️ Architecture

Le projet suit une architecture modulaire avec des composants distincts pour l'intégration, l'ingestion, le traitement des requêtes et la récupération.

✨ Fonctionnalités Principales

📚 Ingestion de Documents

• 📄 Support multi-format (texte, PDF, DOCX, HTML, Markdown)
• 🔄 Découpage pour un traitement efficace
• 💾 Stockage dans Chroma pour une récupération rapide

🔍 Traitement des Requêtes

• 🧠 Utilise LLM pour générer des réponses pertinentes
• 📊 Récupération basée sur le contexte utilisant la similarité cosinus

🖥️ Interface Utilisateur

• 🛠️ Composants pour l'ingestion, les requêtes et la recherche
• 📈 Tableau de bord pour les statistiques et l'activité

🚀 Démarrage Rapide

Prérequis

Python 3.8+ (testé sur 3.13)
Flask
Streamlit
API Ollama
Chroma
pytest

Installation

# Cloner le dépôt
git clone https://github.com/Guiss-Guiss/ScriptumAI.git

# Créer un environnement virtuel
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Installer les dépendances
pip install -r requirements.txt

# Lancer le frontend
streamlit run app.py

📜 Licence

Ce projet est disponible sous une double licence :

• Licence publique générale GNU Affero v3.0 (AGPL-3.0)
• Licence commerciale

Consultez LICENSE et COMMERCIAL_LICENSE.md pour plus de détails.

👥 Contribuer

Veuillez lire notre CONTRIBUTING.md pour plus de détails sur notre code de conduite et le processus de soumission des pull requests.

---

🌍 Español

🎯 Introducción

ScriptumAI es una plataforma privada y avanzada de Generación Aumentada por Recuperación diseñada para la ingestión de documentos, búsqueda semántica y procesamiento de consultas. Utiliza técnicas de vanguardia en aprendizaje automático y procesamiento del lenguaje natural.

🏗️ Arquitectura

El proyecto sigue una arquitectura modular con componentes distintos para la incrustación, ingestión, procesamiento de consultas y recuperación.

✨ Características Principales

📚 Ingestión de Documentos

• 📄 Soporte multi-formato (texto, PDF, DOCX, HTML, Markdown)
• 🔄 Fragmentación para procesamiento eficiente
• 💾 Almacenamiento en Chroma para recuperación rápida

🔍 Procesamiento de Consultas

• 🧠 Usa LLM para generar respuestas relevantes
• 📊 Recuperación basada en contexto usando similitud del coseno

🖥️ Interfaz de Usuario

• 🛠️ Componentes para ingestión, consultas y búsqueda
• 📈 Panel de control para estadísticas y actividad

🚀 Inicio Rápido

Requisitos Previos

Python 3.8+ (probado en 3.13)
Flask
Streamlit
API de Ollama
Chroma
pytest

Instalación

# Clonar el repositorio
git clone https://github.com/Guiss-Guiss/ScriptumAI.git

# Crear un entorno virtual
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Instalar dependencias
pip install -r requirements.txt

# Iniciar el frontend
streamlit run app.py

📜 Licencia

Este proyecto está disponible bajo una licencia dual:

• Licencia Pública General Affero de GNU v3.0 (AGPL-3.0)
• Licencia Comercial

Consulte LICENSE y COMMERCIAL_LICENSE.md para más detalles.

👥 Contribuir

Por favor, lea nuestro CONTRIBUTING.md para obtener detalles sobre nuestro código de conducta y el proceso para enviar pull requests.