feat: create external trigger for ephemeral index (#1212)

Author: radu-mocanu

pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "uipath"
-version = "2.6.11"
+version = "2.6.12"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
 dependencies = [
   "uipath-core>=0.2.0, <0.3.0",
-  "uipath-runtime>=0.6.0, <0.7.0",
+  "uipath-runtime>=0.6.1, <0.7.0",
   "click>=8.3.1",
   "httpx>=0.28.1",
   "pyjwt>=2.10.1",

src/uipath/platform/resume_triggers/_enums.py

@@ -26,6 +26,7 @@ class ExternalTriggerType(str, Enum):
     DEEP_RAG = "deepRag"
     BATCH_TRANSFORM = "batchTransform"
     IXP_EXTRACTION = "ixpExtraction"
+    INDEX_INGESTION = "indexIngestion"
 
 
 class ExternalTrigger(BaseModel):

src/uipath/platform/resume_triggers/_protocol.py

@@ -241,7 +241,7 @@ async def read_trigger(self, trigger: UiPathResumeTrigger) -> Any | None:
 
                     return trigger_response
 
-            case UiPathResumeTriggerType.EPHEMERAL_INDEX:
+            case UiPathResumeTriggerType.INDEX_INGESTION:
                 if trigger.item_key:
                     index = await uipath.context_grounding.retrieve_by_id_async(
                         trigger.item_key
@@ -392,7 +392,7 @@ async def create_trigger(self, suspend_value: Any) -> UiPathResumeTrigger:
                     await self._handle_deep_rag_job_trigger(
                         suspend_value, resume_trigger
                     )
-                case UiPathResumeTriggerType.EPHEMERAL_INDEX:
+                case UiPathResumeTriggerType.INDEX_INGESTION:
                     await self._handle_ephemeral_index_job_trigger(
                         suspend_value, resume_trigger
                     )
@@ -449,7 +449,7 @@ def _determine_trigger_type(self, value: Any) -> UiPathResumeTriggerType:
         if isinstance(value, (CreateDeepRag, WaitDeepRag)):
             return UiPathResumeTriggerType.DEEP_RAG
         if isinstance(value, (CreateEphemeralIndex, WaitEphemeralIndex)):
-            return UiPathResumeTriggerType.EPHEMERAL_INDEX
+            return UiPathResumeTriggerType.INDEX_INGESTION
         if isinstance(value, (CreateBatchTransform, WaitBatchTransform)):
             return UiPathResumeTriggerType.BATCH_RAG
         if isinstance(value, (DocumentExtraction, WaitDocumentExtraction)):
@@ -477,7 +477,7 @@ def _determine_trigger_name(self, value: Any) -> UiPathResumeTriggerName:
         if isinstance(value, (CreateDeepRag, WaitDeepRag)):
             return UiPathResumeTriggerName.DEEP_RAG
         if isinstance(value, (CreateEphemeralIndex, WaitEphemeralIndex)):
-            return UiPathResumeTriggerName.EPHEMERAL_INDEX
+            return UiPathResumeTriggerName.INDEX_INGESTION
         if isinstance(value, (CreateBatchTransform, WaitBatchTransform)):
             return UiPathResumeTriggerName.BATCH_RAG
         if isinstance(value, (DocumentExtraction, WaitDocumentExtraction)):
@@ -570,6 +570,12 @@ async def _handle_ephemeral_index_job_trigger(
                     attachments=value.attachments,
                 )
             )
+            await self._create_external_trigger(
+                ExternalTrigger(
+                    type=ExternalTriggerType.INDEX_INGESTION,
+                    external_id=ephemeral_index.id,
+                )
+            )
             if not ephemeral_index:
                 raise Exception("Failed to create ephemeral index")
             resume_trigger.item_key = ephemeral_index.id

tests/cli/test_hitl.py

@@ -590,7 +590,7 @@ async def test_read_ephemeral_index_trigger_successful(
             new=mock_retrieve_by_id,
         ):
             resume_trigger = UiPathResumeTrigger(
-                trigger_type=UiPathResumeTriggerType.EPHEMERAL_INDEX,
+                trigger_type=UiPathResumeTriggerType.INDEX_INGESTION,
                 item_key=index_id,
             )
             reader = UiPathResumeTriggerReader()
@@ -622,7 +622,7 @@ async def test_read_ephemeral_index_trigger_pending(
             new=mock_retrieve_by_id,
         ):
             resume_trigger = UiPathResumeTrigger(
-                trigger_type=UiPathResumeTriggerType.EPHEMERAL_INDEX,
+                trigger_type=UiPathResumeTriggerType.INDEX_INGESTION,
                 item_key=index_id,
             )
 
@@ -650,7 +650,7 @@ async def test_read_ephemeral_index_trigger_failed(
             new=mock_retrieve_by_id,
         ):
             resume_trigger = UiPathResumeTrigger(
-                trigger_type=UiPathResumeTriggerType.EPHEMERAL_INDEX,
+                trigger_type=UiPathResumeTriggerType.INDEX_INGESTION,
                 item_key=index_id,
             )
 
@@ -1009,7 +1009,7 @@ async def test_create_resume_trigger_create_ephemeral_index(
 
             assert resume_trigger is not None
             assert (
-                resume_trigger.trigger_type == UiPathResumeTriggerType.EPHEMERAL_INDEX
+                resume_trigger.trigger_type == UiPathResumeTriggerType.INDEX_INGESTION
             )
             assert resume_trigger.item_key == index_id
             mock_create_ephemeral_index.assert_called_once_with(
@@ -1035,7 +1035,7 @@ async def test_create_resume_trigger_wait_ephemeral_index(
         resume_trigger = await processor.create_trigger(wait_ephemeral_index)
 
         assert resume_trigger is not None
-        assert resume_trigger.trigger_type == UiPathResumeTriggerType.EPHEMERAL_INDEX
+        assert resume_trigger.trigger_type == UiPathResumeTriggerType.INDEX_INGESTION
         assert resume_trigger.item_key == index_id