feat(models): expand SubActionModel with all transactional and promotional subactions per Apple ILMessageFilterSubAction

README.md

@@ -9,3 +9,13 @@ license: apache-2.0
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+## Organisation des modèles
+
+Les modèles Pydantic (`BaseModel`) sont désormais définis dans `models/models.py` et les énumérations (`Enum`) dans `models/enums.py`. Le fichier `app.py` importe ces classes pour la logique de l'API.
+
+- `models/models.py` : Contient les modèles de données (MessageModel, QueryModel, AppModel, InputModel, OutputModel, ReportModel).
+- `models/enums.py` : Contient les énumérations (ActionModel, SubActionModel).
+
+Cela facilite la réutilisation et la maintenance du code.
+

app.py

@@ -6,8 +6,6 @@ import re
 import httpx
 from fastapi import FastAPI
 from fastapi.responses import JSONResponse, FileResponse
-from pydantic import  BaseModel
-from enum import Enum
 from transformers import pipeline
 from phishing_datasets import submit_entry
 from url_tools import extract_urls, resolve_short_url, extract_domain_from_url
@@ -15,7 +13,8 @@ from urlscan_client import UrlscanClient
 import requests
 from mnemonic_attack import find_confusable_brand
 
-
+from models.models import MessageModel, QueryModel, AppModel, InputModel, OutputModel, ReportModel
+from models.enums import ActionModel, SubActionModel
 
 app = FastAPI()
 urlscan = UrlscanClient()
@@ -25,45 +24,11 @@ for handler in logging.root.handlers[:]:
     logging.root.removeHandler(handler)
 
 logging.basicConfig(
-    level=logging.DEBUG,
+    level=logging.INFO,
     format='%(levelname)s:     %(asctime)s     %(message)s',
     handlers=[logging.StreamHandler(sys.stdout)]
 )
 
-class MessageModel(BaseModel):
-    text: str
-
-class QueryModel(BaseModel):
-    sender: str
-    message: MessageModel
-
-class AppModel(BaseModel):
-    version: str
-
-class InputModel(BaseModel):
-    _version: int
-    query: QueryModel
-    app: AppModel
-
-class ActionModel(Enum):
-    # Insufficient information to determine an action to take. In a query response, has the effect of allowing the message to be shown normally.
-    NONE = 0
-    # Allow the message to be shown normally.
-    ALLOW = 1
-    # Prevent the message from being shown normally, filtered as Junk message.
-    JUNK = 2
-    # Prevent the message from being shown normally, filtered as Promotional message.
-    PROMOTION = 3
-    # Prevent the message from being shown normally, filtered as Transactional message.
-    TRANSACTION = 4
-
-class SubActionModel(Enum):
-    NONE = 0
-
-class OutputModel(BaseModel):
-    action: ActionModel
-    sub_action: SubActionModel
-
 pipe = pipeline(task="text-classification", model="mrm8488/bert-tiny-finetuned-sms-spam-detection")
 
 @app.get("/.well-known/apple-app-site-association", include_in_schema=False)
@@ -117,7 +82,6 @@ def predict(model: InputModel) -> OutputModel:
             case 'promotion':
                 return OutputModel(action=ActionModel.PROMOTION, sub_action=SubActionModel.NONE)
 
-
     # Brand usurpation detection using confusables
     confusable_brand = find_confusable_brand(text)
     if confusable_brand:
@@ -197,10 +161,6 @@ def predict(model: InputModel) -> OutputModel:
     logging.info(f"[FINAL ACTION] {action}")
     return OutputModel(action=action, sub_action=SubActionModel.NONE)
 
-class ReportModel(BaseModel):
-    sender: str
-    message: str
-
 @app.post("/report")
 def report(model: ReportModel):
     submit_entry(model.sender, model.message)

models/enums.py

@@ -0,0 +1,38 @@
+from enum import Enum
+
+class ActionModel(Enum):
+    """
+    Enum representing the main actions for message filtering, according to Apple's ILMessageFilterAction:
+    https://developer.apple.com/documentation/identitylookup/ilmessagefilteraction
+    """
+    NONE = 0         # No action determined, message is handled normally
+    ALLOW = 1        # Allow the message to be shown
+    JUNK = 2         # Filter as junk
+    PROMOTION = 3    # Filter as promotion (extension, not in Apple doc)
+    TRANSACTION = 4  # Filter as transaction (extension, not in Apple doc)
+    # Apple only defines NONE, ALLOW, JUNK; PROMOTION and TRANSACTION are for extension
+
+class SubActionModel(Enum):
+    """
+    Enum representing sub-actions for message filtering, including all transactional and promotional subactions as described in Apple's documentation:
+    https://developer.apple.com/documentation/identitylookup/ilmessagefiltersubaction
+    """
+    # General
+    NONE = 0  # Allows the system to show the message unfiltered due to insufficient information to determine an action.
+    REPORT_JUNK = 1  # Report as junk
+
+    # Transactional Subactions
+    TRANSACTIONAL_OTHERS = 100  # Filtered as an Others message.
+    TRANSACTIONAL_FINANCE = 101  # Filtered as a Finance message.
+    TRANSACTIONAL_ORDERS = 102  # Filtered as an Orders (eCommerce) message.
+    TRANSACTIONAL_REMINDERS = 103  # Filtered as a Reminder message.
+    TRANSACTIONAL_HEALTH = 104  # Filtered as a Health message.
+    TRANSACTIONAL_WEATHER = 105  # Filtered as a Weather message.
+    TRANSACTIONAL_CARRIER = 106  # Filtered as a Carrier message.
+    TRANSACTIONAL_REWARDS = 107  # Filtered as a Rewards message.
+    TRANSACTIONAL_PUBLIC_SERVICES = 108  # Filtered as a Government/Public Services message.
+
+    # Promotional Subactions
+    PROMOTIONAL_OTHERS = 200  # Filtered as an Others message.
+    PROMOTIONAL_OFFERS = 201  # Filtered as an Offers message.
+    PROMOTIONAL_COUPONS = 202  # Filtered as a Coupons message. 

models/models.py

@@ -0,0 +1,25 @@
+from pydantic import BaseModel
+from enum import Enum
+
+class MessageModel(BaseModel):
+    text: str
+
+class QueryModel(BaseModel):
+    sender: str
+    message: MessageModel
+
+class AppModel(BaseModel):
+    version: str
+
+class InputModel(BaseModel):
+    _version: int
+    query: QueryModel
+    app: AppModel
+
+class OutputModel(BaseModel):
+    action: 'ActionModel'
+    sub_action: 'SubActionModel'
+
+class ReportModel(BaseModel):
+    sender: str
+    message: str