# jasper33977296/itri-intent-based-smo architecture

> Architecture diagram of the GitHub repository jasper33977296/itri-intent-based-smo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jasper33977296/itri-intent-based-smo
- Repository: https://github.com/jasper33977296/itri-intent-based-smo

## Overview

##### Project type and purpose
- This is a Django-based, multi-app backend service implementing intent-based conversation, metadata, topic, and workflow management. It exposes RESTful APIs (via Django REST Framework) and Actor components for asynchronous or stateful operations. It is meant to run in Docker (see Dockerfile, docker-compose.yml), and likely uses a relational database plus optional message broker (given `services/broker.py` and ASGI routing).

##### File structure
- Top-level: Docker/Docker-Compose, `manage.py`, `main/` (the Django project), `requirements/`, and a `shell/` helper.
- `main/` splits into:
- `apps/`: four Django apps (`conversation_mgt`, `metadata_mgt`, `topic_mgt`, `workflow_mgt`), each with subfolders: `actors/`, `api/`, `models/`, `serializers/`, `services/`, `templates/`, `tests/`.
- `settings/`: environment‐specific settings.
- `routing.py` & `asgi.py`: support for asynchronous actors or WebSockets.
- `utils/`: shared utility modules (API kits, logging, file/text helpers).
- Presence of `actors/` in each app suggests a domain‐driven or actor pattern layered on top of Django, possibly communicating through an in‐process or external message bus.
- `docker-compose.yml` suggests at least two external services: a relational database (Postgres/MySQL) and optionally a message broker (RabbitMQ/Redis).

##### Extract README insights
- The README only contains the project name “ITRI-Intent-Based-SMO,” confirming an intent‐based conversation/workflow orchestration service.

##### Main components and interactions
a. Components
1. Client(s):
– Mobile/Web front end or third‐party consumers calling the REST API.
2. API Gateway / Load Balancer (optional Docker service).
3. Django Service:
– WSGI (REST API endpoints)
– ASGI (Actors/WebSockets, if used)
– `main/apps/…` apps: Conversation, Metadata, Topic, Workflow.
– Shared Utils (logging, APIKit, FileKit).
4. Actor Layer (in‐process or external broker):
– Each app’s `actors/` modules (ConversationManager, TextManager, etc.).
– Possibly backed by a message broker (RabbitMQ/Redis).
5. Services Layer:
– Business logic in `services/` and `controllers`.
6. Data Layer:
– Django ORM Models and Migrations.
– External Relational Database (PostgreSQL/MySQL).
7. External Services:
– Message Broker (if used).
– Optional cache/Redis for channels or caching.

b. Relationships & data flow
1. Client → API Gateway → Django REST endpoints (`api/views`).
2. Views call Serializers → Models → Database CRUD.
3. For complex operations, Views/Services dispatch tasks to Actors.
4. Actors execute domain logic, update Models via Services/ORM.
5. Optional inter‐actor messaging via Message Broker.
6. Responses flow back to client through Views.

c. Architectural patterns and design principles
– Modular Django apps: each bounded context (conversation, metadata, topic, workflow).
– Clear separation: API layer → Serializer → Service/Actor → Model → DB.
– Actor pattern for asynchronous or stateful workflows.
– Dockerized micro‐services style (each Django instance + separate DB/broker).
– Environment segregation via multiple settings files.

d. Key technologies, frameworks, libraries
– Python 3.x, Django, Django REST Framework.
– ASGI (for Actors/Websockets).
– Docker + docker-compose.
– Relational DB (Postgres/MySQL).
– Message broker (RabbitMQ or Redis).
– Python actor library (custom or third-party).
– Utilities: custom APIKit, FileKit, TextDecorator, logger.

- [ ] All core components (Clients, API, Actors, DB, Broker) are present.
- [ ] Each Django app is represented (conversation, metadata, topic, workflow).
- [ ] Key technologies (Docker, Django, REST, ASGI, DB, Broker) are annotated.
- [ ] Environment/deployment context (Docker Compose) is implied or shown.
- [ ] Include legends or notes for any custom patterns (e.g., Actor pattern).
- [ ] Maintain a balance of detail: not every file, but each major layer and interaction.

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef client fill:#D0E8FF,stroke:#333,stroke-width:1px
    classDef gateway fill:#A8D5FF,stroke:#333,stroke-width:1px
    classDef backend fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef api fill:#B8E0FF,stroke:#333,stroke-width:1px
    classDef actor fill:#FFD8A8,stroke:#333,stroke-width:1px
    classDef service fill:#E8D8FF,stroke:#333,stroke-width:1px
    classDef db fill:#C8E6C9,stroke:#333,stroke-width:1px
    classDef util fill:#E0E0E0,stroke:#333,stroke-width:1px
    classDef external fill:#F0F0F0,stroke:#666,stroke-width:1px

    subgraph "Clients"
        Client["Clients (Web/Mobile/Third-party)"]:::client
    end
    Client -->|HTTP REST| APIGW["API Gateway/Load Balancer"]:::gateway

    APIGW -->|Container Orchestration| DockerCompose["Docker Compose"]:::external
    subgraph "Docker Compose"
        Dockerfile["Dockerfile"]:::external
        ComposeFile["docker-compose.yml"]:::external
    end
    DockerCompose --> Dockerfile
    DockerCompose --> ComposeFile

    APIGW -->|WSGI| DjangoWSGI["Django WSGI Service"]:::backend
    APIGW -->|ASGI| DjangoASGI["Django ASGI Service"]:::backend

    subgraph "Django Service"
        DjangoWSGI
        DjangoASGI
        Manage["manage.py"]:::external
        DjangoWSGI --> Manage
        subgraph "Apps"
            subgraph "Conversation Management"
                CM_API_URL["URLs"]:::api
                CM_API_VIEWS["Views"]:::api
                CM_Actor1["ConversationManager"]:::actor
                CM_Actor2["TextManager"]:::actor
                CM_Service["Services"]:::service
                CM_Models["Models"]:::db
                CM_API_URL --> CM_API_VIEWS
                CM_API_VIEWS --> CM_Service
                CM_Service --> CM_Models
                CM_ActorsGroup["Actors"]:::actor
                CM_ActorsGroup --> CM_Actor1
                CM_ActorsGroup --> CM_Actor2
                CM_Actor1 --> CM_Service
                CM_Actor2 --> CM_Service
            end
            subgraph "Metadata Management"
                MD_API_URL["URLs"]:::api
                MD_API_VIEWS["Views"]:::api
                MD_Actor1["ConversationManager"]:::actor
                MD_Actor2["TextManager"]:::actor
                MD_Actor3["UserManager"]:::actor
                MD_Actor4["WorkflowManager"]:::actor
                MD_Service1["ConversationController"]:::service
                MD_Service2["TextController"]:::service
                MD_Service3["UserController"]:::service
                MD_Service4["WorkflowController"]:::service
                MD_Models["Models"]:::db
                MD_API_URL --> MD_API_VIEWS
                MD_API_VIEWS --> MD_Service1
                MD_Service1 --> MD_Models
                MD_ActorsGroup["Actors"]:::actor
                MD_ActorsGroup --> MD_Actor1
                MD_ActorsGroup --> MD_Actor2
                MD_ActorsGroup --> MD_Actor3
                MD_ActorsGroup --> MD_Actor4
                MD_Actor1 --> MD_Service1
                MD_Actor2 --> MD_Service2
                MD_Actor3 --> MD_Service3
                MD_Actor4 --> MD_Service4
            end
            subgraph "Topic Management"
                TM_API_URL["URLs"]:::api
                TM_API_VIEWS["Views"]:::api
                TM_Actor["TopicManager"]:::actor
                TM_Service["broker"]:::service
                TM_Models["Models"]:::db
                TM_API_URL --> TM_API_VIEWS
                TM_API_VIEWS --> TM_Service
                TM_Service --> TM_Models
                TM_ActorsGroup["Actors"]:::actor
                TM_ActorsGroup --> TM_Actor
                TM_Actor --> TM_Service
            end
            subgraph "Workflow Management"
                WM_API_URL["URLs"]:::api
                WM_API_VIEWS["Views"]:::api
                WM_Actor1["Prosumer"]:::actor
                WM_Actor2["WorkflowManager"]:::actor
                WM_Service["workflows"]:::service
                WM_Models["Models"]:::db
                WM_API_URL --> WM_API_VIEWS
                WM_API_VIEWS --> WM_Service
                WM_Service --> WM_Models
                WM_ActorsGroup["Actors"]:::actor
                WM_ActorsGroup --> WM_Actor1
                WM_ActorsGroup --> WM_Actor2
                WM_Actor1 --> WM_Service
                WM_Actor2 --> WM_Service
            end
        end
        SharedUtils["Shared Utilities (ApiKit, FileKit, TextDecorator, Logger)"]:::util
        DjangoASGI --> SharedUtils
        DjangoWSGI --> SharedUtils
    end

    subgraph "External Infrastructure"
        Database["Relational Database (Postgres/MySQL)"]:::db
        Broker["Message Broker (RabbitMQ/Redis)"]:::external
    end

    CM_Models --> Database
    MD_Models --> Database
    TM_Models --> Database
    WM_Models --> Database

    CM_ActorsGroup -->|events| Broker
    MD_ActorsGroup -->|events| Broker
    TM_ActorsGroup -->|events| Broker
    WM_ActorsGroup -->|events| Broker

    class Client client
    class APIGW gateway
    class DockerCompose,Dockerfile,ComposeFile external
    class DjangoWSGI,DjangoASGI backend
    class SharedUtils util

    click Dockerfile "https://github.com/jasper33977296/itri-intent-based-smo/tree/main/Dockerfile"
    click ComposeFile "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/docker-compose.yml"
    click Manage "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/manage.py"
    click DjangoWSGI "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/wsgi.py"
    click DjangoASGI "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/asgi.py"
    click DjangoASGI "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/routing.py"
    click CM_API_URL "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/conversation_mgt/api/urls.py"
    click CM_API_VIEWS "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/conversation_mgt/api/views/views.py"
    click MD_API_URL "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/api/urls.py"
    click MD_API_VIEWS "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/api/views/views.py"
    click TM_API_URL "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/topic_mgt/api/urls.py"
    click TM_API_VIEWS "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/topic_mgt/api/views/views.py"
    click WM_API_URL "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/workflow_mgt/api/urls.py"
    click WM_API_VIEWS "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/workflow_mgt/api/views/views.py"
    click CM_Actor1 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/conversation_mgt/actors/ConversationManager.py"
    click CM_Actor2 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/conversation_mgt/actors/TextManager.py"
    click MD_Actor1 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/actors/ConversationManager.py"
    click MD_Actor2 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/actors/TextManager.py"
    click MD_Actor3 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/actors/UserManager.py"
    click MD_Actor4 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/actors/WorkflowManager.py"
    click TM_Actor "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/topic_mgt/actors/TopicManager.py"
    click WM_Actor1 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/workflow_mgt/actors/Prosumer.py"
    click WM_Actor2 "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/workflow_mgt/actors/WorkflowManager.py"
    click CM_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/conversation_mgt/models/models.py"
    click MD_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/models/ConversationModel.py"
    click MD_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/models/TextModel.py"
    click MD_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/models/UserModel.py"
    click MD_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/metadata_mgt/models/WorkflowModel.py"
    click TM_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/topic_mgt/models/models.py"
    click WM_Models "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/apps/workflow_mgt/models/models.py"
    click SharedUtils "https://github.com/jasper33977296/itri-intent-based-smo/blob/main/main/utils/ApiKit.py"
```
