# abdelilah04116/autoresearchflow architecture

> Architecture diagram of the GitHub repository abdelilah04116/autoresearchflow, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abdelilah04116/autoresearchflow
- Repository: https://github.com/abdelilah04116/autoresearchflow

## Overview

Pour représenter au mieux l’architecture de ce **Système Multi-Agent de Recherche Intelligente**, voici comment procéder pas à pas :

##### Identifier le type de projet et son objectif
- C’est une application back-end Python (monolithe modulaire) exposant une API REST via **FastAPI**, orchestrant un pipeline de 7 agents IA spécialisés, en interaction avec des services externes (Tavily, Gemini) et une base SQLite.

##### Analyser la structure de fichiers
- agents/ : 7 modules d’agents (Research, Summarizer, Editor, Validator, Feedback, Memory, Orchestrator)
- main.py : point d’entrée de l’API FastAPI
- demo.py : script de démonstration
- models.py : définitions des requêtes/réponses
- config.py + .env.example : configuration des clés et variables d’environnement
- requirements.txt : dépendances

##### Extraire les informations clés du README
- Le **flow** principal démarre par une requête utilisateur (`POST /workflow`), gérée par FastAPI → OrchestratorAgent
- L’Orchestrator séquence les appels aux ResearchAgent, SummarizerAgent, EditorAgent, ValidatorAgent, FeedbackAgent et MemoryAgent
- Les agents Research/Summarizer/Editor appellent respectivement les API externes Tavily et Gemini 2.0 Flash
- MemoryAgent persiste et récupère l’historique dans SQLite
- FeedbackAgent collecte et analyse les retours utilisateurs

##### Composants principaux à modéliser
- **Client** (Utilisateur ou script demo.py)
- **API Layer** (FastAPI dans main.py)
- **Orchestrator Agent**
- **Agents spécialisés**
- ResearchAgent ↔ Tavily API
- SummarizerAgent ↔ Gemini API
- EditorAgent ↔ Gemini API
- ValidatorAgent (mode humain/simulé)
- FeedbackAgent
- MemoryAgent ↔ SQLite DB
- **Stockage** : SQLite
- **Services externes** : Tavily Search, Gemini 2.0 Flash

##### Relations et flux de données
- Client → FastAPI → Orchestrator
- Orchestrator → (Research → Summarizer → Editor → Validator)
- Chaque appel d’agent peut déclencher un appel synchrone à un service externe
- Orchestrator → FeedbackAgent (en parallèle ou post-process)
- Orchestrator → MemoryAgent pour persistance et historique
- Enfin, réponse agrégée retournée au client

##### Points d’architecture et design patterns
- **Pipeline / Workflow Orchestration** : séquencement linéaire des agents
- **Séparation des responsabilités** : chaque agent implémente une facette distincte du traitement
- **Modules interchangeables** : possibilité d’ajouter/remplacer un agent (ex. nouveaux styles d’édition, critères de validation)
- **Externalisation des services LLM** : deux fournisseurs externes (Tavily, Gemini)
- **Persistance légère** : SQLite embarqué, facilement remplacé par un SGBD plus robuste ou un cache Redis

##### Conseils pour le diagramme
- Utiliser des **boîtes** (rectangles) pour chaque composant : API, Orchestrator, chaque agent, DB, services externes
- Relier avec des **flèches** directionnelles indiquant le sens des appels/réponses
- **Colorer** :
- Bleu clair pour composants internes (API, Orchestrator, agents)
- Vert pour la base de données
- Orange pour services externes
- Violet pour le client
- **Formes distinctes** :
- Rectangle bord arrondi pour le client
- Rectangle simple pour modules internes
- Cylindre pour la base de données
- Nuage (cloud) pour services externes
- Ajouter **légende** si nécessaire

##### Exemple de sections du diagramme
- Zone “Client” en haut à gauche
- Zone “API / Orchestrator” au centre
- Suite de modules “Agents” alignés horizontalement ou en pipeline
- En dessous, “Database (SQLite)” et à droite “Tavily API” + “Gemini API”
- Flèches :
- Client → API
- API → Orchestrator
- Orchestrator → ResearchAgent → Tavily
- Orchestrator → SummarizerAgent → Gemini
- … etc.
- Orchestrator → MemoryAgent → SQLite
- Orchestrator → FeedbackAgent

En suivant ces recommandations, vous obtiendrez un schéma clair, complet et fidèle à l’architecture du projet. Pensez à y inclure les détails de configuration (variables d’environnement) ou modes (simulation vs production) si vous souhaitez enrichir la vue.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Client"
        Client(["Client (demo.py)"]):::client
    end

    subgraph "API Layer"
        API["FastAPI (main.py)"]:::internal
        Models["Models (models.py)"]:::internal
        Config["Config (config.py / .env)"]:::internal
    end

    subgraph "Orchestrator"
        Orchestrator["OrchestratorAgent"]:::internal
    end

    subgraph "Agents"
        Research["ResearchAgent"]:::internal
        Summarizer["SummarizerAgent"]:::internal
        Editor["EditorAgent"]:::internal
        Validator["ValidatorAgent"]:::internal
        Feedback["FeedbackAgent"]:::internal
        Memory["MemoryAgent"]:::internal
    end

    DB["SQLite DB"]:::db

    subgraph "External Services"
        Tavily["Tavily API"]:::external
        Gemini["Gemini API"]:::external
    end

    Client -->|POST /workflow| API
    API -->|orchestrates| Orchestrator
    Orchestrator -->|calls| Research
    Research -->|search| Tavily
    Orchestrator -->|calls| Summarizer
    Summarizer -->|summarize| Gemini
    Orchestrator -->|calls| Editor
    Editor -->|edit| Gemini
    Orchestrator -->|calls| Validator
    Orchestrator -->|calls| Feedback
    Orchestrator -->|calls| Memory
    Memory -->|persist/retrieve| DB

    click Client "https://github.com/abdelilah04116/autoresearchflow/blob/main/demo.py"
    click API "https://github.com/abdelilah04116/autoresearchflow/blob/main/main.py"
    click Models "https://github.com/abdelilah04116/autoresearchflow/blob/main/models.py"
    click Config "https://github.com/abdelilah04116/autoresearchflow/blob/main/config.py"
    click Orchestrator "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/orchestrator_agent.py"
    click Research "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/research_agent.py"
    click Summarizer "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/summarizer_agent.py"
    click Editor "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/editor_agent.py"
    click Validator "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/validator_agent.py"
    click Feedback "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/feedback_agent.py"
    click Memory "https://github.com/abdelilah04116/autoresearchflow/blob/main/agents/memory_agent.py"

    classDef client fill:#E0B3FF,stroke:#333,stroke-width:1px;
    classDef internal fill:#CFEFFF,stroke:#333,stroke-width:1px;
    classDef db fill:#B5FFB5,stroke:#333,stroke-width:1px;
    classDef external fill:#FFD699,stroke:#333,stroke-width:1px;
```
