# ahmedmostafaattiaaa/rag_system architecture

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

- Interactive diagram: https://gitdiagram.com/ahmedmostafaattiaaa/rag_system
- Repository: https://github.com/ahmedmostafaattiaaa/rag_system

## Overview

##### Project type and purpose
- This is a monolithic Python backend service built with FastAPI, implementing a Retrieval-Augmented Generation (RAG) system.
- It exposes HTTP endpoints for data ingestion, processing, and project-level operations, then orchestrates calls to external components (e.g., LLM APIs, vector store).

##### File structure
- Entry point: src/main.py (instantiates FastAPI, includes routes).
- Routes layer: src/routes/… defines HTTP endpoints and Pydantic schemes.
- Controllers: src/controllers/… contain business logic (DataController, ProcessController, ProjectController).
- Models: src/models/enums define domain constants.
- Helpers: src/helpers/config.py loads environment variables.
- Assets: src/assets holds static files (if any).
- Configuration: .env/.env.example for secrets, requirements.txt for dependencies.

##### README for additional insights
- Server run command: uvicorn main:app --reload …
- Marks use of environment variables for API keys.

##### Elements
- Labels for each component (e.g., “FastAPI App”, “DataController”)
- Orange clouds for external APIs (LLM)
- Grey oval for environment/config
- Related modules in containers (e.g., “src/controllers” cluster).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["External Client"]:::external

    %% FastAPI App Entry Point
    FastAPIApp["FastAPI App"]:::app
    Client -->|HTTP Request| FastAPIApp
    click FastAPIApp "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/main.py"

    %% API Layer
    subgraph "API Layer (Routes)"
        direction TB
        BaseRoutes["Base Routes"]:::routes
        DataRoutes["Data Routes"]:::routes
        Schemes["Request/Response Schemas"]:::routes
    end
    FastAPIApp -->|includes routes| BaseRoutes
    FastAPIApp -->|includes routes| DataRoutes
    FastAPIApp -->|uses schemas| Schemes
    click BaseRoutes "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/routes/base.py"
    click DataRoutes "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/routes/data.py"
    click Schemes "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/routes/schemes/data.py"

    %% Business Logic Layer
    subgraph "Business Logic (Controllers)"
        direction TB
        BaseController["BaseController"]:::controller
        DataController["DataController"]:::controller
        ProcessController["ProcessController"]:::controller
        ProjectController["ProjectController"]:::controller
    end
    BaseRoutes -->|calls| BaseController
    DataRoutes -->|calls| DataController
    DataRoutes -->|calls| ProcessController
    BaseRoutes -->|calls| ProjectController
    click BaseController "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/controllers/BaseController.py"
    click DataController "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/controllers/DataController.py"
    click ProcessController "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/controllers/ProcessController.py"
    click ProjectController "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/controllers/ProjectController.py"

    %% Helpers & Models
    subgraph "Helpers & Models"
        direction TB
        ConfigLoader["Config Loader"]:::helper
        ProcessingEnum["Processing Enums"]:::model
        ResponseEnum["Response Enums"]:::model
    end
    ConfigLoader -->|loads from| EnvExample
    BaseController --> ConfigLoader
    DataController --> ConfigLoader
    ProcessController --> ConfigLoader
    ProjectController --> ConfigLoader
    ProcessController --> ProcessingEnum
    ProcessController --> ResponseEnum
    click ConfigLoader "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/helpers/config.py"
    click ProcessingEnum "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/models/enums/ProcessingEnum.py"
    click ResponseEnum "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/models/enums/ResponseEnums.py"

    %% Environment Example and Requirements
    EnvExample[".env Example"]:::config
    Requirements["requirements.txt"]:::config
    click EnvExample "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/.env.example"
    click Requirements "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/requirements.txt"

    %% Data & Assets
    subgraph "Data & Assets"
        direction TB
        Assets["Assets Directory"]:::datastore
        VectorDB["Vector Store"]:::datastore
    end
    DataController -->|stores/retrieves| Assets
    DataController -->|queries| VectorDB
    ProcessController -->|queries| VectorDB
    click Assets "https://github.com/ahmedmostafaattiaaa/rag_system/blob/main/src/assets/.gitkeep"

    %% External Services
    subgraph "External Services"
        direction TB
        LLMAPI["LLM API"]:::externalAPI
    end
    ProcessController -->|requests embeddings/completions| LLMAPI

    %% Response Flow
    BaseController -->|returns response| FastAPIApp
    DataController -->|returns data| FastAPIApp
    ProcessController -->|returns processed data| FastAPIApp
    ProjectController -->|returns metadata| FastAPIApp

    %% Styles
    classDef external fill:#f9f,stroke:#333,stroke-width:1px
    classDef app fill:#bbf,stroke:#333,stroke-width:1px
    classDef routes fill:#bbf,stroke:#333,stroke-width:1px
    classDef controller fill:#bbf,stroke:#333,stroke-width:1px
    classDef helper fill:#bbf,stroke:#333,stroke-width:1px
    classDef model fill:#bbf,stroke:#333,stroke-width:1px
    classDef config fill:#bbb,stroke:#333,stroke-width:1px
    classDef datastore fill:#bfb,stroke:#333,stroke-width:1px
    classDef externalAPI fill:#f96,stroke:#333,stroke-width:1px
```
