Merge pull request #77 from akvo/feature/76-update-registered-app-implement-default-prompt

Feature/76 update registered app implement default prompt

Author: dedenbangkit

backend/app/api/api_v1/apps.py

@@ -21,6 +21,8 @@
     AppRotateResponse,
     ErrorResponse,
     DocumentUploadItem,
+    AppUpdateRequest,
+    AppUpdateResponse
 )
 from mcp_clients.kb_mcp_endpoint_service import KnowledgeBaseMCPEndpointService
 
@@ -239,3 +241,56 @@ async def get_documents(
         kb_id=current_app.knowledge_base_id,
     )
     return res
+
+
+@router.patch(
+    "",
+    response_model=AppUpdateResponse,
+    responses={
+        400: {"model": ErrorResponse, "description": "Validation error"},
+        401: {"model": ErrorResponse, "description": "Unauthorized - Invalid or missing token"},
+        403: {"model": ErrorResponse, "description": "Forbidden - Inactive app"},
+        404: {"model": ErrorResponse, "description": "App not found"},
+    },
+)
+def update_app(
+    *,
+    db: Session = Depends(get_db),
+    current_app: App = Depends(get_current_app),
+    update_data: AppUpdateRequest,
+) -> Any:
+    """
+    Partially update app metadata.
+
+    Only provided fields will be updated. Access token and client_id
+    will remain unchanged.
+
+    Requires Bearer token authentication.
+    """
+    if not AppService.is_app_active(current_app):
+        raise HTTPException(
+            status_code=status.HTTP_403_FORBIDDEN,
+            detail="App is not active",
+        )
+
+    try:
+        updated_app = AppService.update_app(
+            db=db,
+            app=current_app,
+            update_data=update_data,
+        )
+
+        return AppUpdateResponse(
+            app_id=updated_app.app_id,
+            app_name=updated_app.app_name,
+            domain=updated_app.domain,
+            default_chat_prompt=updated_app.default_chat_prompt,
+            chat_callback=updated_app.chat_callback_url,
+            upload_callback=updated_app.upload_callback_url,
+            callback_token=updated_app.callback_token,
+            updated_at=updated_app.updated_at,
+        )
+    except ValueError as e:
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(e))
+    except Exception as e:
+        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=f"Failed to update app: {str(e)}")

backend/app/api/api_v1/jobs.py

@@ -41,18 +41,35 @@ async def create_job(
         Form(
             ...,
             description=(
-                "JSON string defining the job details.\n\n"
-                "Example:\n"
-                "{\n"
-                '  "job": "chat",\n'
-                '  "prompt": "Explain AI simply.",\n'
-                '  "chats": [\n'
-                '    {"role": "user", "content": "What is AI?"},\n'
-                '    {"role": "assistant", "content": "AI means Artificial Intelligence."}\n'
-                '  ],\n'
-                '  "callback_params": {"reply_to": "wa:+1234"},\n'
-                '  "trace_id": "trace_abc_123"\n'
-                "}"
+                """
+                JSON string defining the job details.
+                Example chat job:
+                "{
+                    "job": "chat",
+                    "prompt": "Explain AI simply.",
+                    "chats": [
+                        {"role": "user", "content": "What is AI?"},
+                        {"role": "assistant", "content": "AI means Artificial Intelligence."}
+                    ],
+                    "callback_params": {"reply_to": "wa:+1234"},
+                    "trace_id": "trace_abc_123"
+                }"
+
+                ---
+
+                Example upload job:
+                "{
+                    "job": "upload",
+                    "metadata": {
+                        "kb_id": 1,
+                        "title": "Chlorination SOP",
+                        "tags": ["chlorine","ops"]
+                    },
+                    "callback_params": {
+                        "ui_upload_id": "up_456"
+                    }
+                }"
+                """
             ),
         ),
     ],
@@ -93,6 +110,7 @@ async def create_job(
             job_id=job_record.id,
             data=data,
             callback_url=current_app.chat_callback_url,
+            app_default_prompt=current_app.default_chat_prompt,
             knowledge_base_ids=knowledge_base_ids,
         )
     elif job_type == "upload":

backend/app/schemas/app.py

@@ -32,6 +32,36 @@ class Config:
         from_attributes = True
 
 
+class AppUpdateRequest(BaseModel):
+    app_name: Optional[str] = None
+    domain: Optional[str] = None
+    default_chat_prompt: Optional[str] = None
+    chat_callback: Optional[str] = None
+    upload_callback: Optional[str] = None
+    callback_token: Optional[str] = None
+
+    @field_validator("chat_callback", "upload_callback")
+    @classmethod
+    def validate_https_url(cls, v: Optional[str]) -> Optional[str]:
+        if v is not None and not v.startswith("https://"):
+            raise ValueError("Callback URLs must use HTTPS")
+        return v
+
+
+class AppUpdateResponse(BaseModel):
+    app_id: str
+    app_name: str
+    domain: str
+    default_chat_prompt: Optional[str] = None
+    chat_callback: str
+    upload_callback: str
+    callback_token: Optional[str] = None
+    updated_at: datetime
+
+    class Config:
+        from_attributes = True
+
+
 class AppMeResponse(BaseModel):
     app_id: str
     app_name: str

backend/app/services/app_service.py

@@ -3,7 +3,7 @@
 from sqlalchemy.orm import Session
 
 from app.models.app import App, AppStatus
-from app.schemas.app import AppRegisterRequest
+from app.schemas.app import AppRegisterRequest, AppUpdateRequest
 
 # Default scopes for new apps
 DEFAULT_SCOPES = ["jobs.write", "kb.read", "kb.write", "apps.read"]
@@ -64,6 +64,33 @@ def create_app(
 
         return app, access_token
 
+    @staticmethod
+    def update_app(
+        db: Session,
+        app: App,
+        update_data: AppUpdateRequest,
+    ) -> App:
+        """
+        Partially update app fields without resetting identifiers or tokens."""
+        updated = False
+        data = update_data.dict(exclude_unset=True)
+
+        for field, value in data.items():
+            if value is not None:
+                if field == "chat_callback":
+                    app.chat_callback_url = value
+                elif field == "upload_callback":
+                    app.upload_callback_url = value
+                elif hasattr(app, field):
+                    setattr(app, field, value)
+                updated = True
+
+        if updated:
+            db.add(app)
+            db.commit()
+            db.refresh(app)
+        return app
+
     @staticmethod
     def get_app_by_access_token(db: Session, access_token: str) -> Optional[App]:
         """Get app by access token."""

backend/app/services/chat_job_service.py

@@ -16,6 +16,7 @@ async def execute_chat_job(
     job_id: str,
     data: dict,
     callback_url: str,
+    app_default_prompt: str,
     knowledge_base_ids: List[int] = []
 ):
     """Background job executor for chat jobs (non-streaming)."""
@@ -26,12 +27,19 @@ async def execute_chat_job(
     try:
         JobService.update_status_to_running(db, job_id)
 
+        # prompt from app logic
+        app_default_prompt = app_default_prompt or None
+        job_payload_prompt = data.get("prompt") or None
+        app_final_prompt = (
+            job_payload_prompt if job_payload_prompt else app_default_prompt
+        ) or ""
+        # eol prompt from app logic
+
         prompt_service = PromptService(db=db)
         settings_service = SystemSettingsService(db=db)
         top_k = settings_service.get_top_k()
 
         chats = data.get("chats", [])
-        prompt = data.get("prompt") or None
         callback_url = data.get("callback_url") or callback_url
 
         chat_history = []
@@ -44,14 +52,18 @@ async def execute_chat_job(
         query = chat_history[-1].get("content") if chat_history else ""
         chat_history = chat_history[:-1] if chat_history else []
 
+        # default rag prompt
         contextualize_prompt = prompt_service.get_full_contextualize_prompt()
         qa_prompt = prompt_service.get_full_qa_strict_prompt()
 
+        # combined prompt
+        final_prompt = qa_prompt + "\n\n" + app_final_prompt
+
         state = {
             "query": query,
             "chat_history": chat_history,
             "contextualize_prompt_str": contextualize_prompt,
-            "qa_prompt_str": prompt or qa_prompt,
+            "qa_prompt_str": final_prompt,
             "scope": {
                 "knowledge_base_ids": knowledge_base_ids,
                 "top_k": top_k,

backend/app/tasks/chat_task.py

@@ -9,6 +9,7 @@ def execute_chat_job_task(
     job_id: str,
     data: dict,
     callback_url: str,
+    app_default_prompt: str,
     knowledge_base_ids: list[int] = [],
 ):
     """
@@ -22,6 +23,7 @@ def execute_chat_job_task(
                 job_id=job_id,
                 data=data,
                 callback_url=callback_url,
+                app_default_prompt=app_default_prompt,
                 knowledge_base_ids=knowledge_base_ids
             )
         )