# brunotanabe/curriculum-vitae-query-assistant architecture

> Architecture diagram of the GitHub repository brunotanabe/curriculum-vitae-query-assistant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/brunotanabe/curriculum-vitae-query-assistant
- Repository: https://github.com/brunotanabe/curriculum-vitae-query-assistant

## Overview

##### Project type and purpose
- This is a backend-only, containerized AI microservice (“curriculum-vitae-query-assistant”) that exposes a Swagger-enabled REST/HTTP API to:
- Ingest resume files (PDF, JPEG, PNG)
- Run OCR (via EasyOCR or PyPDF)
- Summarize/extract content using an LLM (via HuggingFace)
- Answer job-fit queries
- Log usage metrics (no document storage)
- It follows a hexagonal (ports-and-adapters) and domain-driven structure with two main apps: core and curricula_vitae.

##### File structure
- Top-level:
- setup/: ASGI/WGSI entrypoints and Django/FastAPI settings
- apps/core/: core abstractions (boundaries, controls, entities, utils)
- apps/curricula_vitae/: domain-specific code (API views, services, DI container, entities, serializers, migrations)
- Dockerfile & docker-compose.yaml: containerization
- manage.py, pyproject.toml/requirements.txt: Python project and dependencies
- The “boundaries” directories define ports (interfaces to OCR/LLM/DB), “controls” implement use-case logic and standard response handling, “entities” hold enums and data models.

##### README for additional insights
- Confirms OCR + LLM services, Dockerization, Swagger API, and logging (likely to a relational DB via Django migrations).

##### Detailed guidance
- Outer adapters (controllers & external-service implementations)
- Inner core (use-case controls & entities)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client
    Client["Client (Postman/Frontend)"]:::external

    %% API Gateway
    APIG["Swagger REST API\n(API Gateway)"]:::api
    click APIG "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/setup/urls.py"

    %% Web Server
    WS["Web Server (ASGI)"]:::internal
    click WS "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/setup/asgi.py"

    %% Application Layer: Adapters & DI
    subgraph "Adapters & DI Layer" 
        direction TB
        DI["Dependency Injection Container"]:::internal
        click DI "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/containers/curriculum_container.py"
        View["Curriculum API View"]:::internal
        click View "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/boundaries/curriculum_api_view.py"
        URL["Curriculum URL Router"]:::internal
        click URL "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/boundaries/curriculum_url.py"
        Doc["Curriculum Doc Adapter"]:::internal
        click Doc "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/boundaries/curriculum_doc.py"
    end

    %% Use-case Layer / Business Logic
    subgraph "Use-Case Layer" 
        direction TB
        Resp["Standard API Response"]:::internal
        click Resp "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/controls/standard_api_response.py"
        ExcH["Standard Exception Handler"]:::internal
        click ExcH "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/controls/standard_exception_handler.py"
        Mid["Standard Response Middleware"]:::internal
        click Mid "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/controls/standard_response_middleware.py"
        Rend["Standard Response Renderer"]:::internal
        click Rend "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/controls/standard_response_renderer.py"
        CurExc["Curriculum Exception"]:::internal
        click CurExc "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/controls/curriculum_exception.py"
    end

    %% Domain Layer
    subgraph "Domain Layer" 
        direction TB
        subgraph Ports
            direction TB
            OcrP["OCR Service Port"]:::internal
            click OcrP "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/interfaces/ocr_service.py"
            PdfP["PDF Service Port"]:::internal
            click PdfP "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/interfaces/pdf_service.py"
            LlmP["LLM Service Port"]:::internal
            click LlmP "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/interfaces/llm_service.py"
        end
        subgraph Adapters
            direction TB
            EasyOCR["EasyOCR Adapter"]:::service
            click EasyOCR "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/easyocr_service.py"
            PyPDF["PyPDF Adapter"]:::service
            click PyPDF "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/pypdf_service.py"
            HF["HuggingFace Adapter"]:::service
            click HF "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/boundaries/huggingface_service.py"
        end
        subgraph Entities
            direction TB
            EF1["allowed_files Enum"]:::internal
            click EF1 "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/entities/enums/allowed_files.py"
            EF2["allowed_images Enum"]:::internal
            click EF2 "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/entities/enums/allowed_images.py"
            EF3["ocr_models Enum"]:::internal
            click EF3 "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/entities/enums/ocr_models.py"
            EF4["llm_models Enum"]:::internal
            click EF4 "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/entities/enums/llm_models.py"
            EF5["request_status Enum"]:::internal
            click EF5 "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/core/entities/enums/request_status.py"
            CM["Curriculum Model"]:::internal
            click CM "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/entities/models/curriculum.py"
        end
        subgraph Serializers
            direction TB
            InS["Curriculum Create Input"]:::internal
            click InS "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/entities/serializers/curriculum_create_input.py"
            OutS["Curriculum Create Output"]:::internal
            click OutS "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/apps/curricula_vitae/entities/serializers/curriculum_create_output.py"
        end
    end

    %% External Services
    OCRE["OCR Engine (EasyOCR)"]:::external
    LLME["LLM Engine (HuggingFace)"]:::external
    PDFE["PDF Engine (PyPDF)"]:::external

    %% Persistence
    DB["Database (Usage Logs)"]:::infra
    click DB "https://github.com/brunotanabe/curriculum-vitae-query-assistant/tree/main/apps/curricula_vitae/migrations/"

    %% Containerization
    DC["Docker Container"]:::infra
    click DC "https://github.com/brunotanabe/curriculum-vitae-query-assistant/tree/main/Dockerfile"
    click DC "https://github.com/brunotanabe/curriculum-vitae-query-assistant/blob/main/docker-compose.yaml"

    %% Connections
    Client -->|HTTP Request| APIG
    APIG -->|forwards| WS
    WS -->|routes| View
    View -->|injects| DI
    DI -->|orchestrates| Resp
    Resp -->|calls| ExcH
    ExcH -->|uses| Mid
    Mid -->|renders| Rend
    Rend -->|handles| CurExc
    CurExc -->|invokes| OcrP
    CurExc -->|invokes| PdfP
    CurExc -->|invokes| LlmP
    OcrP -->|adapter| EasyOCR
    PdfP -->|adapter| PyPDF
    LlmP -->|adapter| HF
    EasyOCR -->|OCR request/response| OCRE
    PyPDF -->|PDF bytes| PDFE
    HF -->|LLM prompt/answer| LLME
    Rend -->|serializes| InS
    Rend -->|serializes| OutS
    Rend -->|uses| CM
    Rend -->|uses| EF1
    Rend -->|uses| EF2
    Rend -->|uses| EF3
    Rend -->|uses| EF4
    Rend -->|uses| EF5
    WS -->|logs| DB
    WS -->|runs in| DC
    APIG -->|runs in| DC

    %% Styles
    classDef external fill:#9f6,stroke:#333,stroke-width:1px
    classDef internal fill:#bbf,stroke:#333,stroke-width:1px
    classDef service fill:#afa,stroke:#333,stroke-width:1px
    classDef api fill:#8cf,stroke:#333,stroke-width:1px
    classDef infra fill:#f96,stroke:#333,stroke-width:1px
```
