✨ add support for rag param in workflow executions (#319)

Author: sebastianMindee

mindee/client.py

@@ -263,7 +263,7 @@ def execute_workflow(
 
         if not options:
             options = WorkflowOptions(
-                alias=None, priority=None, full_text=False, public_url=None
+                alias=None, priority=None, full_text=False, public_url=None, rag=False
             )
 
         return self._send_to_workflow(GeneratedV1, input_source, workflow_id, options)

mindee/input/workflow_options.py

@@ -14,15 +14,19 @@ class WorkflowOptions:
     """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."""
+    rag: bool
+    """Whether to enable Retrieval-Augmented Generation."""
 
     def __init__(
         self,
         alias: Optional[str] = None,
         priority: Optional[ExecutionPriority] = None,
         full_text: Optional[bool] = False,
         public_url: Optional[str] = None,
+        rag: Optional[bool] = False,
     ):
         self.alias = alias
         self.priority = priority
         self.full_text = full_text if full_text else False
         self.public_url = public_url
+        self.rag = rag if rag else False

mindee/mindee_http/workflow_endpoint.py

@@ -45,6 +45,8 @@ def workflow_execution_post(
         params = {}
         if options.full_text:
             params["full_text_ocr"] = "true"
+        if options.rag:
+            params["rag"] = "true"
 
         if isinstance(input_source, UrlInputSource):
             data["document"] = input_source.url

tests/workflows/test_workflow_integration.py

@@ -30,7 +30,7 @@ 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)
+    options = WorkflowOptions(alias=alias, priority=priority, rag=True)
 
     response = mindee_client.execute_workflow(input_source, workflow_id, options)