add public url parameter to workflows

Author: sebastianMindee

mindee/client.py

@@ -4,6 +4,7 @@
 
 from mindee.error.mindee_error import MindeeClientError, MindeeError
 from mindee.error.mindee_http_error import handle_error
+from mindee.input import WorkflowOptions
 from mindee.input.local_response import LocalResponse
 from mindee.input.page_options import PageOptions
 from mindee.input.sources import (
@@ -25,7 +26,6 @@
 from mindee.mindee_http.workflow_endpoint import WorkflowEndpoint
 from mindee.mindee_http.workflow_settings import WorkflowSettings
 from mindee.parsing.common.async_predict_response import AsyncPredictResponse
-from mindee.parsing.common.execution_priority import ExecutionPriority
 from mindee.parsing.common.feedback_response import FeedbackResponse
 from mindee.parsing.common.inference import Inference
 from mindee.parsing.common.predict_response import PredictResponse
@@ -239,10 +239,8 @@ def execute_workflow(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
         workflow_id: str,
+        options: Optional[WorkflowOptions] = None,
         page_options: Optional[PageOptions] = None,
-        alias: Optional[str] = None,
-        priority: Optional[ExecutionPriority] = None,
-        full_text: bool = False,
     ) -> WorkflowResponse:
         """
         Send the document to an asynchronous endpoint and return its ID in the queue.
@@ -252,9 +250,7 @@ def execute_workflow(
         :param workflow_id: ID of the workflow.
         :param page_options: If set, remove pages from the document as specified. This is done before sending the file\
  to the server. It is useful to avoid page limitations.
-        :param alias: Optional alias for the document.
-        :param priority: Optional priority for the document.
-        :param full_text: Whether to include the full OCR text response in compatible APIs.
+        :param options: Options for the workflow.
         :return:
         """
         if isinstance(input_source, LocalInputSource):
@@ -267,9 +263,12 @@ def execute_workflow(
 
         logger.debug("Sending document to workflow: %s", workflow_id)
 
-        return self._send_to_workflow(
-            GeneratedV1, input_source, workflow_id, alias, priority, full_text
-        )
+        if not options:
+            options = WorkflowOptions(
+                alias=None, priority=None, full_text=False, public_url=None
+            )
+
+        return self._send_to_workflow(GeneratedV1, input_source, workflow_id, options)
 
     def _validate_async_params(
         self, initial_delay_sec: float, delay_sec: float, max_retries: int
@@ -484,9 +483,7 @@ def _send_to_workflow(
         product_class: Type[Inference],
         input_source: Union[LocalInputSource, UrlInputSource],
         workflow_id: str,
-        alias: Optional[str] = None,
-        priority: Optional[ExecutionPriority] = None,
-        full_text: bool = False,
+        options: WorkflowOptions,
     ) -> WorkflowResponse:
         """
         Sends a document to a workflow.
@@ -497,9 +494,7 @@ def _send_to_workflow(
         :param input_source: The document/source file to use.
             Has to be created beforehand.
         :param workflow_id: ID of the workflow.
-        :param alias: Optional alias for the document.
-        :param priority: Priority for the document.
-        :param full_text: Whether to include the full OCR text response in compatible APIs.
+        :param options: Optional options for the workflow.
         :return:
         """
         if input_source is None:
@@ -509,9 +504,7 @@ def _send_to_workflow(
             WorkflowSettings(api_key=self.api_key, workflow_id=workflow_id)
         )
 
-        response = workflow_endpoint.workflow_execution_post(
-            input_source, alias, priority, full_text
-        )
+        response = workflow_endpoint.workflow_execution_post(input_source, options)
 
         dict_response = response.json()
 

mindee/input/__init__.py

@@ -9,3 +9,4 @@
     PathInput,
     UrlInputSource,
 )
+from mindee.input.workflow_options import WorkflowOptions

mindee/input/workflow_options.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+from mindee.parsing.common import ExecutionPriority
+
+
+class WorkflowOptions:
+    """Options to pass to a workflow execution."""
+
+    alias: Optional[str]
+    """Alias for the document."""
+    priority: Optional[ExecutionPriority]
+    """Priority of the document."""
+    full_text: bool
+    """Whether to include the full OCR text response in compatible APIs."""
+    public_url: Optional[str]
+    """A unique, encrypted URL for accessing the document validation interface without requiring authentication."""
+
+    def __init__(
+        self,
+        alias: Optional[str] = None,
+        priority: Optional[ExecutionPriority] = None,
+        full_text: Optional[bool] = False,
+        public_url: Optional[str] = None,
+    ):
+        self.alias = alias
+        self.priority = priority
+        self.full_text = full_text if full_text else False
+        self.public_url = public_url

mindee/mindee_http/workflow_endpoint.py

@@ -1,11 +1,10 @@
-from typing import Optional, Union
+from typing import Union
 
 import requests
 
-from mindee.input import LocalInputSource, UrlInputSource
+from mindee.input import LocalInputSource, UrlInputSource, WorkflowOptions
 from mindee.mindee_http.base_endpoint import BaseEndpoint
 from mindee.mindee_http.workflow_settings import WorkflowSettings
-from mindee.parsing.common.execution_priority import ExecutionPriority
 
 
 class WorkflowEndpoint(BaseEndpoint):
@@ -24,29 +23,27 @@ def __init__(self, settings: WorkflowSettings) -> None:
     def workflow_execution_post(
         self,
         input_source: Union[LocalInputSource, UrlInputSource],
-        alias: Optional[str] = None,
-        priority: Optional[ExecutionPriority] = None,
-        full_text: bool = False,
+        options: WorkflowOptions,
     ):
         """
         Sends the document to the workflow.
 
         :param input_source: The document/source file to use.
             Has to be created beforehand.
-        :param alias: Optional alias for the document.
-        :param priority: Priority for the document.
-        :param full_text: Whether to include the full OCR text response in compatible APIs.
+        :param options: Options for the workflow.
         :return:
         """
         data = {}
 
-        if alias:
-            data["alias"] = alias
-        if priority:
-            data["priority"] = priority.value
+        if options.alias:
+            data["alias"] = options.alias
+        if options.priority:
+            data["priority"] = options.priority.value
+        if options.public_url:
+            data["public_url"] = options.public_url
 
         params = {}
-        if full_text:
+        if options.full_text:
             params["full_text_ocr"] = "true"
 
         if isinstance(input_source, UrlInputSource):

tests/workflows/test_workflow_integration.py

@@ -4,6 +4,7 @@
 import pytest
 
 from mindee import Client
+from mindee.input import WorkflowOptions
 from mindee.parsing.common.execution_priority import ExecutionPriority
 from tests.product import PRODUCT_DATA_DIR
 
@@ -29,10 +30,9 @@ def test_workflow(mindee_client: Client, workflow_id: str, input_path: str):
     current_date_time = datetime.now().strftime("%Y-%m-%d-%H:%M:%S")
     alias = f"python-{current_date_time}"
     priority = ExecutionPriority.LOW
+    options = WorkflowOptions(alias=alias, priority=priority)
 
-    response = mindee_client.execute_workflow(
-        input_source, workflow_id, alias=alias, priority=priority
-    )
+    response = mindee_client.execute_workflow(input_source, workflow_id, options)
 
     assert response.api_request.status_code == 202
     assert response.execution.file.alias == f"python-{current_date_time}"