Passa al contenuto principale

API

Registro delle modifiche e aggiornamenti alle API di Emblema.

Versione 0.0.1 (Agosto 2025)​

🎉 Nuove Funzionalità​

Documentazione Completa​

  • Aggiunta documentazione Docusaurus: Creato progetto completo di documentazione con Docusaurus
  • Strutturazione contenuti: Organizzazione completa in sezioni Platform, Sviluppatori, Manuale Utente e API
  • Claude Code integration: Aggiunto comando /doc-it per aggiornamento automatico documentazione

Sezione Platform​

  • Architettura microservizi: Documentazione completa dell'architettura Service Mesh con Traefik
  • Design di sistema: High-level e Low-level design con diagrammi e flussi
  • Infrastruttura Docker: Documentazione Docker Compose modulare con configurazioni specifiche
  • Componenti core: Layer dati, autenticazione, servizi backend e app frontend

Sezione Sviluppatori​

  • Setup ambiente: Requisiti sistema aggiornati con GPU NVIDIA RTX ADA 6000 (96GB VRAM minimi)
  • Architettura codice: Pattern monorepo, convenzioni naming, organizzazione modulare
  • Background tasks: Guida completa sistema Celery con chunking strategies
  • AI integration: Documentazione LiteLLM, BGE-M3 embeddings, Milvus search
  • Testing e debugging: Framework di testing proposto (non ancora implementato)
  • Deployment CI/CD: Pipeline Docker, Kubernetes, cloud deployment strategies

🔧 Miglioramenti Tecnici​

API Design​

  • Sistema gerarchico: Implementazione API pattern /api/v1/Entity1/{id}/Entity2/{id2}
  • Permessi root-based: Sistema permessi su entità radice con cascade
  • Entity actions: Endpoint dedicati /api/v1/Entity/{id}/action/{actionName}

Requisiti Sistema​

  • GPU Requirements: Aggiornamento a 2x NVIDIA RTX ADA 6000 (96GB VRAM) come minimo assoluto
  • OS Support: Ubuntu 22.04 LTS come unico OS supportato per production
  • CUDA Support: Aggiornamento a CUDA ≥12.0 per architettura ADA

Chunking System​

  • Strategie semplificate: 3 chunkers principali (Document, Audio, Video)
  • BGE-M3 tokenizer: Chunking basato su token invece di caratteri
  • Speaker diarization: Supporto WhisperX con profilazione speaker
  • Re-chunking: Supporto ri-chunking senza riprocessare file originale

📚 Documentazione​

Manuali e Guide​

  • Manuale utente: Guide per upload documenti, chat AI, knowledge base
  • Guide servizi: Background tasks, integrazione AI, MCP server
  • Riferimenti tecnici: Variabili ambiente, comandi utili, glossario
  • Troubleshooting: Guide risoluzione problemi comuni

Struttura Progetto​

  • Monorepo organization: Documentazione struttura apps/, packages/, config/
  • Naming conventions: TypeScript/Python/Docker conventions
  • Best practices: Security, performance, development workflow

❌ Rimozioni e Deprecazioni​

Pattern Obsoleti​

  • SPP Pattern: Rimosso completamente Single Purpose Process pattern
  • spp-retrieval service: Sostituito da retrieval diretto via Milvus
  • i18n support: Rimossa internazionalizzazione, app solo in italiano
  • Kubernetes deployment: Rimosso supporto, focus su Docker Compose

File Rimossi​

  • spp-pattern.md - Pattern non più utilizzato
  • i18n.md - Funzionalità rimossa
  • creare-spp.md - Guide obsolete
  • kubernetes.md - Deployment non supportato

🐛 Bug Fix​

Documentazione​

  • MDX compilation: Fix caratteri < e > in markdown
  • Sidebar navigation: Rimozione riferimenti a file eliminati
  • Link interni: Correzione collegamenti tra sezioni

Template e Configurazioni​

  • Plop templates: Aggiornamento template generazione servizi
  • Docker configs: Correzione configurazioni modulari
  • Environment variables: Standardizzazione variabili sviluppo/production

🔄 Modifiche Breaking​

API Changes​

  • Endpoint structure: Nuovo pattern gerarchico API
  • Permission system: Cambio da SPP-based a entity-based permissions
  • Error responses: Standardizzazione formato errori

Infrastructure​

  • GPU Requirements: Incremento sostanziale requisiti hardware minimi
  • OS Support: Limitazione a solo Ubuntu 22.04 per production
  • Service Architecture: Migrazione da SPP a servizi specializzati

📈 Metriche​

Documentazione​

  • 230+ file creati: Documentazione completa da zero
  • 56k+ righe aggiunte: Contenuto tecnico dettagliato
  • 4 sezioni principali: Platform, Sviluppatori, Utenti, API
  • 100+ pagine markdown: Coverage completa funzionalità

Versioni Precedenti​

Pre-0.0.1 (2024)​

  • Sviluppo iniziale piattaforma Emblema
  • Implementazione servizi base
  • Prototipo interfaccia utente
  • Setup iniziale infrastruttura Docker

Questa pagina ti è stata utile?