add create ephemeral index

CalebMartinUiPath · CalebMartinUiPath · commit 0e7732ccc642 · 2026-01-15T17:13:49.000-08:00
diff --git a/src/uipath/platform/common/interrupt_models.py b/src/uipath/platform/common/interrupt_models.py
@@ -84,6 +84,19 @@ class WaitDeepRag(BaseModel):
     index_folder_key: str | None = None
 
 
+class CreateEphemeralIndex(BaseModel):
+    """Model representing a Jit Index task creation."""
+
+    usage: str
+    attachments: list[str]
+
+
+class WaitEphemeralIndex(BaseModel):
+    """Model representing a wait Jit Index task."""
+
+    id: str
+
+
 class CreateBatchTransform(BaseModel):
     """Model representing a Batch Transform task creation."""
 
diff --git a/src/uipath/platform/context_grounding/__init__.py b/src/uipath/platform/context_grounding/__init__.py
@@ -12,6 +12,7 @@
     DeepRagCreationResponse,
     DeepRagResponse,
     DeepRagStatus,
+    IndexStatus,
 )
 from .context_grounding_index import ContextGroundingIndex
 from .context_grounding_payloads import (
@@ -52,6 +53,7 @@
     "DeepRagCreationResponse",
     "DeepRagResponse",
     "DeepRagStatus",
+    "IndexStatus",
     "DropboxDataSource",
     "DropboxSourceConfig",
     "GoogleDriveDataSource",
diff --git a/src/uipath/platform/context_grounding/_context_grounding_service.py b/src/uipath/platform/context_grounding/_context_grounding_service.py
@@ -4,7 +4,6 @@
 
 import httpx
 from pydantic import Field, TypeAdapter
-from typing_extensions import deprecated
 
 from ..._utils import Endpoint, RequestSpec, header_folder, resource_override
 from ..._utils._ssl_context import get_httpx_client_kwargs
@@ -39,8 +38,8 @@
     BucketSourceConfig,
     ConfluenceDataSource,
     ConfluenceSourceConfig,
+    CreateEphemeralIndexPayload,
     CreateIndexPayload,
-    CreateJitIndexPayload,
     DropboxDataSource,
     DropboxSourceConfig,
     GoogleDriveDataSource,
@@ -279,31 +278,19 @@ async def retrieve_async(
             raise Exception("ContextGroundingIndex not found") from e
 
     @traced(name="contextgrounding_retrieve_by_id", run_type="uipath")
-    @deprecated("Use retrieve instead")
-    def retrieve_by_id(
-        self,
-        id: str,
-        folder_key: Optional[str] = None,
-        folder_path: Optional[str] = None,
-    ) -> Any:
+    def retrieve_by_id(self, id: str) -> Any:
         """Retrieve context grounding index information by its ID.
 
         This method provides direct access to a context index using its unique
         identifier, which can be more efficient than searching by name.
 
         Args:
             id (str): The unique identifier of the context index.
-            folder_key (Optional[str]): The key of the folder where the index resides.
-            folder_path (Optional[str]): The path of the folder where the index resides.
 
         Returns:
             Any: The index information, including its configuration and metadata.
         """
-        spec = self._retrieve_by_id_spec(
-            id,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
+        spec = self._retrieve_by_id_spec(id)
 
         return self.request(
             spec.method,
@@ -312,31 +299,19 @@ def retrieve_by_id(
         ).json()
 
     @traced(name="contextgrounding_retrieve_by_id", run_type="uipath")
-    @deprecated("Use retrieve_async instead")
-    async def retrieve_by_id_async(
-        self,
-        id: str,
-        folder_key: Optional[str] = None,
-        folder_path: Optional[str] = None,
-    ) -> Any:
+    async def retrieve_by_id_async(self, id: str) -> Any:
         """Retrieve asynchronously context grounding index information by its ID.
 
         This method provides direct access to a context index using its unique
         identifier, which can be more efficient than searching by name.
 
         Args:
             id (str): The unique identifier of the context index.
-            folder_key (Optional[str]): The key of the folder where the index resides.
-            folder_path (Optional[str]): The path of the folder where the index resides.
 
         Returns:
             Any: The index information, including its configuration and metadata.
         """
-        spec = self._retrieve_by_id_spec(
-            id,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
+        spec = self._retrieve_by_id_spec(id)
 
         response = await self.request_async(
             spec.method,
@@ -402,20 +377,16 @@ def create_index(
         return ContextGroundingIndex.model_validate(response.json())
 
     @resource_override(resource_type="index")
-    @traced(name="contextgrounding_create_jit_index", run_type="uipath")
-    def create_jit_index(
+    @traced(name="contextgrounding_create_ephemeral_index", run_type="uipath")
+    def create_ephemeral_index(
         self,
         usage: str,
         attachments: list[uuid.UUID],
-        folder_key: Optional[str] = None,
-        folder_path: Optional[str] = None,
     ) -> ContextGroundingIndex:
-        """Create a new context jit grounding index."""
-        spec = self._create_jit_spec(
+        """Create a new context ephemeral grounding index."""
+        spec = self._create_ephemeral_spec(
             usage,
             attachments,
-            folder_path=folder_path,
-            folder_key=folder_key,
         )
 
         response = self.request(
@@ -1226,19 +1197,15 @@ def _create_spec(
             },
         )
 
-    def _create_jit_spec(
+    def _create_ephemeral_spec(
         self,
         usage: str,
         attachments: list[uuid.UUID] = None,
-        folder_key: Optional[str] = None,
-        folder_path: Optional[str] = None,
     ) -> RequestSpec:
         """Create request spec for index creation."""
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        data_source_dict = self._build_ephemeral_data_source(attachments)
 
-        data_source_dict = self._build_jit_data_source(attachments)
-
-        payload = CreateJitIndexPayload(
+        payload = CreateEphemeralIndexPayload(
             usage=usage,
             data_source=data_source_dict,
         )
@@ -1247,12 +1214,12 @@ def _create_jit_spec(
             method="POST",
             endpoint=Endpoint("/ecs_/v2/indexes/createephemeral"),
             json=payload.model_dump(by_alias=True, exclude_none=True),
-            headers={
-                **header_folder(folder_key, None),
-            },
+            headers={},
         )
 
-    def _build_jit_data_source(self, attachments: list[uuid.UUID]) -> Dict[str, Any]:
+    def _build_ephemeral_data_source(
+        self, attachments: list[uuid.UUID]
+    ) -> Dict[str, Any]:
         data_source: AttachmentsDataSource
         data_source = AttachmentsDataSource(attachments=attachments)
         return data_source.model_dump(
@@ -1329,20 +1296,11 @@ def _build_data_source(self, source: SourceConfig) -> Dict[str, Any]:
 
         return data_source.model_dump(by_alias=True, exclude_none=True)
 
-    def _retrieve_by_id_spec(
-        self,
-        id: str,
-        folder_key: Optional[str] = None,
-        folder_path: Optional[str] = None,
-    ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
-
+    def _retrieve_by_id_spec(self, id: str) -> RequestSpec:
         return RequestSpec(
             method="GET",
             endpoint=Endpoint(f"/ecs_/v2/indexes/{id}"),
-            headers={
-                **header_folder(folder_key, None),
-            },
+            headers={},
         )
 
     def _delete_by_id_spec(
diff --git a/src/uipath/platform/context_grounding/context_grounding.py b/src/uipath/platform/context_grounding/context_grounding.py
@@ -41,6 +41,15 @@ class DeepRagStatus(str, Enum):
     FAILED = "Failed"
 
 
+class IndexStatus(str, Enum):
+    """Enum representing possible index tasks status."""
+
+    QUEUED = "Queued"
+    IN_PROGRESS = "InProgress"
+    SUCCESSFUL = "Successful"
+    FAILED = "Failed"
+
+
 class Citation(BaseModel):
     """Model representing a deep RAG citation."""
 
diff --git a/src/uipath/platform/context_grounding/context_grounding_payloads.py b/src/uipath/platform/context_grounding/context_grounding_payloads.py
@@ -141,7 +141,7 @@ class CreateIndexPayload(BaseModel):
     model_config = ConfigDict(populate_by_name=True)
 
 
-class CreateJitIndexPayload(BaseModel):
+class CreateEphemeralIndexPayload(BaseModel):
     """ """
 
     usage: str = Field(description="Index usage")
diff --git a/src/uipath/platform/resume_triggers/_protocol.py b/src/uipath/platform/resume_triggers/_protocol.py
@@ -35,7 +35,14 @@
     WaitJob,
     WaitTask,
 )
-from uipath.platform.context_grounding import DeepRagStatus
+from uipath.platform.common.interrupt_models import (
+    CreateEphemeralIndex,
+    WaitEphemeralIndex,
+)
+from uipath.platform.context_grounding import DeepRagStatus, IndexStatus
+from uipath.platform.context_grounding.context_grounding_index import (
+    ContextGroundingIndex,
+)
 from uipath.platform.errors import (
     BatchTransformNotCompleteException,
     ExtractionNotCompleteException,
@@ -226,6 +233,33 @@ async def read_trigger(self, trigger: UiPathResumeTrigger) -> Any | None:
 
                     return trigger_response
 
+            case UiPathResumeTriggerType.EPHEMERAL_INDEX:
+                if trigger.item_key:
+                    index = uipath.context_grounding.retrieve_by_id(trigger.item_key)
+
+                    ephemeral_index = ContextGroundingIndex(**index)
+
+                    ephemeral_index_status = ephemeral_index.last_ingestion_status
+
+                    if ephemeral_index_status in (
+                        IndexStatus.QUEUED,
+                        IndexStatus.IN_PROGRESS,
+                    ):
+                        raise UiPathPendingTriggerError(
+                            ErrorCategory.SYSTEM,
+                            f"Index ingestion is not finished yet. Current status: {ephemeral_index_status}",
+                        )
+
+                    if ephemeral_index_status != IndexStatus.SUCCESSFUL:
+                        raise UiPathFaultedTriggerError(
+                            ErrorCategory.USER,
+                            f"Index ingestion '{ephemeral_index.name}' did not finish successfully.",
+                        )
+
+                    trigger_response = ephemeral_index
+
+                    return trigger_response
+
             case UiPathResumeTriggerType.BATCH_RAG:
                 if trigger.item_key:
                     destination_path = self._extract_field(
@@ -354,6 +388,10 @@ async def create_trigger(self, suspend_value: Any) -> UiPathResumeTrigger:
                     await self._handle_deep_rag_job_trigger(
                         suspend_value, resume_trigger, uipath
                     )
+                case UiPathResumeTriggerType.EPHEMERAL_INDEX:
+                    await self._handle_ephemeral_index_job_trigger(
+                        suspend_value, resume_trigger, uipath
+                    )
                 case UiPathResumeTriggerType.BATCH_RAG:
                     await self._handle_batch_rag_job_trigger(
                         suspend_value, resume_trigger, uipath
@@ -391,6 +429,8 @@ def _determine_trigger_type(self, value: Any) -> UiPathResumeTriggerType:
             return UiPathResumeTriggerType.JOB
         if isinstance(value, (CreateDeepRag, WaitDeepRag)):
             return UiPathResumeTriggerType.DEEP_RAG
+        if isinstance(value, (CreateEphemeralIndex, WaitEphemeralIndex)):
+            return UiPathResumeTriggerType.EPHEMERAL_INDEX
         if isinstance(value, (CreateBatchTransform, WaitBatchTransform)):
             return UiPathResumeTriggerType.BATCH_RAG
         if isinstance(value, (DocumentExtraction, WaitDocumentExtraction)):
@@ -415,6 +455,8 @@ def _determine_trigger_name(self, value: Any) -> UiPathResumeTriggerName:
             return UiPathResumeTriggerName.JOB
         if isinstance(value, (CreateDeepRag, WaitDeepRag)):
             return UiPathResumeTriggerName.DEEP_RAG
+        if isinstance(value, (CreateEphemeralIndex, WaitEphemeralIndex)):
+            return UiPathResumeTriggerName.EPHEMERAL_INDEX
         if isinstance(value, (CreateBatchTransform, WaitBatchTransform)):
             return UiPathResumeTriggerName.BATCH_RAG
         if isinstance(value, (DocumentExtraction, WaitDocumentExtraction)):
@@ -479,6 +521,21 @@ async def _handle_deep_rag_job_trigger(
                 raise Exception("Failed to start deep rag")
             resume_trigger.item_key = deep_rag.id
 
+    async def _handle_ephemeral_index_job_trigger(
+        self, value: Any, resume_trigger: UiPathResumeTrigger, uipath: UiPath
+    ) -> None:
+        """Handle ephemeral index"""
+        if isinstance(value, WaitEphemeralIndex):
+            resume_trigger.item_key = value.ephemeral_index.id
+        elif isinstance(value, CreateEphemeralIndex):
+            ephemeral_index = uipath.context_grounding.create_ephemeral_index(
+                usage=value.usage,
+                attachments=value.attachments,
+            )
+            if not ephemeral_index:
+                raise Exception("Failed to start ephemeral index")
+            resume_trigger.item_key = ephemeral_index.id
+
     async def _handle_batch_rag_job_trigger(
         self, value: Any, resume_trigger: UiPathResumeTrigger, uipath: UiPath
     ) -> None:
