Merge pull request #262 from AvaCodeSolutions/feat/258/ai-tool

feat: #258 add feature to edit paragraph with AI assistant

Author: payamnj

django_email_learning/ai/__init__.py

@@ -0,0 +1,6 @@
+from typing import Protocol
+
+
+class AiServiceProtocol(Protocol):
+    def edit_text(self, text: str, model: str) -> str:
+        ...

django_email_learning/ai/ai_service_protocol.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AiConfig(AppConfig):
+    name = "django_email_learning.ai"

django_email_learning/ai/apps.py

@@ -0,0 +1,13 @@
+from enum import Enum
+from .open_ai_adapter import OpenAiAdapter
+from .ai_service_protocol import AiServiceProtocol
+
+
+class LanguageModel(Enum):
+    GPT_4O_MINI = ("gpt-4o-mini", OpenAiAdapter)
+    GPT_5_NANO = ("gpt-5-nano", OpenAiAdapter)
+    GPT_5_MINI = ("gpt-5-mini", OpenAiAdapter)
+
+    def __init__(self, model_name: str, adapter_class: type[AiServiceProtocol]) -> None:
+        self.model_name = model_name
+        self.adapter_class = adapter_class

django_email_learning/ai/language_models.py

@@ -0,0 +1,34 @@
+from .ai_service_protocol import AiServiceProtocol
+from openai import OpenAI
+from django.conf import settings
+import os
+
+
+DJANGO_EMAIL_LEARNING_CONFIG = getattr(settings, "DJANGO_EMAIL_LEARNING", {})
+
+
+class OpenAiAdapter(AiServiceProtocol):
+    def __init__(self) -> None:
+        API_KEY = DJANGO_EMAIL_LEARNING_CONFIG.get("AI", {}).get(
+            "OPENAI_API_KEY", os.getenv("OPENAI_API_KEY")
+        )
+        if not API_KEY:
+            raise ValueError(
+                "OpenAI API key is required. Please set it in Django settings or as an environment variable."
+            )
+        self._client = OpenAI(api_key=API_KEY)
+
+    def edit_text(self, text: str, model: str) -> str:
+        # Placeholder for OpenAI API integration
+        response = self._client.responses.create(
+            model=model,
+            input=[
+                {
+                    "role": "developer",
+                    "content": "You are a helpful assistant that edits text for grammar and clarity. Preserve the existing HTML structure and tags when present. Do not add wrapper containers like <ul>, <ol>, or <p> unless they already exist in the input. Return ONLY the edited text.",
+                },
+                {"role": "user", "content": text},
+            ],
+            store=False,
+        )
+        return response.output_text

django_email_learning/ai/open_ai_adapter.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel, Field
+from .language_models import LanguageModel
+
+
+class EditTextRequest(BaseModel):
+    input: str = Field(
+        min_length=40,
+        max_length=500,
+        description="The input to be edited by the AI model.",
+    )
+    model: LanguageModel = Field(default=LanguageModel.GPT_5_NANO)

django_email_learning/ai/serializers.py

@@ -0,0 +1,12 @@
+from django.urls import path
+from .views import EditTextView
+
+app_name = "django_email_learning"
+
+urlpatterns = [
+    path(
+        "organizations/<int:organization_id>/edit-text/",
+        EditTextView.as_view(),
+        name="edit_text",
+    ),
+]

django_email_learning/ai/urls.py

@@ -0,0 +1,22 @@
+from django.utils.decorators import method_decorator
+from django_email_learning.decorators import accessible_for
+from django.http import JsonResponse
+from django.views import View
+from pydantic import ValidationError
+from .serializers import EditTextRequest
+import json
+
+
+@method_decorator(accessible_for(roles={"admin", "editor"}), name="post")
+class EditTextView(View):
+    def post(self, request, *args, **kwargs) -> JsonResponse:  # type: ignore[no-untyped-def]
+        payload = json.loads(request.body)
+        try:
+            serializer = EditTextRequest.model_validate(payload)
+            input = serializer.input
+            model = serializer.model
+            ai_adapter = model.adapter_class()
+            edited_text = ai_adapter.edit_text(input, model.model_name)
+            return JsonResponse({"edited_text": edited_text})
+        except ValidationError as e:
+            return JsonResponse({"error": str(e)}, status=400)

django_email_learning/ai/views.py

@@ -17,6 +17,7 @@
 
 
 DJANGO_EMAIL_LEARNING_SETTINGS: dict = getattr(settings, "DJANGO_EMAIL_LEARNING", {})
+AI_CONFIGURATIONS: dict = DJANGO_EMAIL_LEARNING_SETTINGS.get("AI", {})
 
 
 @method_decorator(login_required, name="dispatch")
@@ -66,6 +67,7 @@ def get_shared_context(self) -> Dict[str, Any]:
                         and getattr(self.request.user, "has_platform_admin_role", False)
                     )
                 ),
+                "aiTextEditingModel": AI_CONFIGURATIONS.get("TEXT_EDITING_MODEL"),
                 "customLogo": {
                     "horizontalLight": DJANGO_EMAIL_LEARNING_SETTINGS.get("LOGO", {})
                     .get("HORIZONTAL_LOCKUP", {})
@@ -261,6 +263,8 @@ def get_locale_messages(self) -> Dict[str, str]:
             "update_lesson": _("Update Lesson"),
             "new_quiz": _("New Quiz"),
             "update_quiz": _("Update Quiz"),
+            "editing": _("Editing..."),
+            "edit_with_ai": _("Edit with AI"),
             "lesson_title": _("Lesson Title"),
             "lesson_waiting_tooltip": _(
                 "Set the amount of time that we should wait after the previous lesson or quiz submission before sending this lesson"

django_email_learning/platform/views.py

@@ -33,3 +33,11 @@
             ),
         ),
     ]
+
+if apps.is_installed("django_email_learning.ai"):
+    urlpatterns += [
+        path(
+            "api/ai/",
+            include("django_email_learning.ai.urls", namespace="api_ai"),
+        ),
+    ]