feat: support workflow version specification in workflow and chat APIs (#23188)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

api/services/app_generate_service.py

@@ -1,5 +1,6 @@
+import uuid
 from collections.abc import Generator, Mapping
-from typing import Any, Union
+from typing import Any, Optional, Union
 
 from openai._exceptions import RateLimitError
 
@@ -15,6 +16,7 @@ from libs.helper import RateLimiter
 from models.model import Account, App, AppMode, EndUser
 from models.workflow import Workflow
 from services.billing_service import BillingService
+from services.errors.app import WorkflowIdFormatError, WorkflowNotFoundError
 from services.errors.llm import InvokeRateLimitError
 from services.workflow_service import WorkflowService
 
@@ -86,7 +88,8 @@ class AppGenerateService:
                     request_id=request_id,
                 )
             elif app_model.mode == AppMode.ADVANCED_CHAT.value:
-                workflow = cls._get_workflow(app_model, invoke_from)
+                workflow_id = args.get("workflow_id")
+                workflow = cls._get_workflow(app_model, invoke_from, workflow_id)
                 return rate_limit.generate(
                     AdvancedChatAppGenerator.convert_to_event_stream(
                         AdvancedChatAppGenerator().generate(
@@ -101,7 +104,8 @@ class AppGenerateService:
                     request_id=request_id,
                 )
             elif app_model.mode == AppMode.WORKFLOW.value:
-                workflow = cls._get_workflow(app_model, invoke_from)
+                workflow_id = args.get("workflow_id")
+                workflow = cls._get_workflow(app_model, invoke_from, workflow_id)
                 return rate_limit.generate(
                     WorkflowAppGenerator.convert_to_event_stream(
                         WorkflowAppGenerator().generate(
@@ -210,14 +214,27 @@ class AppGenerateService:
         )
 
     @classmethod
-    def _get_workflow(cls, app_model: App, invoke_from: InvokeFrom) -> Workflow:
+    def _get_workflow(cls, app_model: App, invoke_from: InvokeFrom, workflow_id: Optional[str] = None) -> Workflow:
         """
         Get workflow
         :param app_model: app model
         :param invoke_from: invoke from
+        :param workflow_id: optional workflow id to specify a specific version
         :return:
         """
         workflow_service = WorkflowService()
+
+        # If workflow_id is specified, get the specific workflow version
+        if workflow_id:
+            try:
+                workflow_uuid = uuid.UUID(workflow_id)
+            except ValueError:
+                raise WorkflowIdFormatError(f"Invalid workflow_id format: '{workflow_id}'. ")
+            workflow = workflow_service.get_published_workflow_by_id(app_model=app_model, workflow_id=workflow_id)
+            if not workflow:
+                raise WorkflowNotFoundError(f"Workflow not found with id: {workflow_id}")
+            return workflow
+
         if invoke_from == InvokeFrom.DEBUGGER:
             # fetch draft workflow by app_model
             workflow = workflow_service.get_draft_workflow(app_model=app_model)

api/services/errors/app.py

@@ -8,3 +8,11 @@ class WorkflowHashNotEqualError(Exception):
 
 class IsDraftWorkflowError(Exception):
     pass
+
+
+class WorkflowNotFoundError(Exception):
+    pass
+
+
+class WorkflowIdFormatError(Exception):
+    pass

api/services/workflow_service.py

@@ -129,7 +129,10 @@ class WorkflowService:
         if not workflow:
             return None
         if workflow.version == Workflow.VERSION_DRAFT:
-            raise IsDraftWorkflowError(f"Workflow is draft version, id={workflow_id}")
+            raise IsDraftWorkflowError(
+                f"Cannot use draft workflow version. Workflow ID: {workflow_id}. "
+                f"Please use a published workflow version or leave workflow_id empty."
+            )
         return workflow
 
     def get_published_workflow(self, app_model: App) -> Optional[Workflow]: