feat: add ecs jit sdk

Author: CalebMartinUiPath

src/uipath/platform/common/interrupt_models.py

@@ -4,12 +4,17 @@
 
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 
+from uipath.platform.context_grounding.context_grounding_index import (
+    ContextGroundingIndex,
+)
+
 from ..action_center.tasks import Task, TaskRecipient
 from ..context_grounding import (
     BatchTransformCreationResponse,
     BatchTransformOutputColumn,
     CitationMode,
     DeepRagCreationResponse,
+    EphemeralIndexUsage,
 )
 from ..documents import FileContent, StartExtractionResponse
 from ..orchestrator.job import Job
@@ -85,6 +90,19 @@ class WaitDeepRag(BaseModel):
     index_folder_key: str | None = None
 
 
+class CreateEphemeralIndex(BaseModel):
+    """Model representing a Ephemeral Index task creation."""
+
+    usage: EphemeralIndexUsage
+    attachments: list[str]
+
+
+class WaitEphemeralIndex(BaseModel):
+    """Model representing a wait Ephemeral Index task."""
+
+    index: ContextGroundingIndex
+
+
 class CreateBatchTransform(BaseModel):
     """Model representing a Batch Transform task creation."""
 

src/uipath/platform/context_grounding/__init__.py

@@ -12,6 +12,8 @@
     DeepRagCreationResponse,
     DeepRagResponse,
     DeepRagStatus,
+    EphemeralIndexUsage,
+    IndexStatus,
 )
 from .context_grounding_index import ContextGroundingIndex
 from .context_grounding_payloads import (
@@ -52,8 +54,10 @@
     "DeepRagCreationResponse",
     "DeepRagResponse",
     "DeepRagStatus",
+    "IndexStatus",
     "DropboxDataSource",
     "DropboxSourceConfig",
+    "EphemeralIndexUsage",
     "GoogleDriveDataSource",
     "GoogleDriveSourceConfig",
     "Indexer",

src/uipath/platform/context_grounding/_context_grounding_service.py

@@ -3,7 +3,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
@@ -30,13 +29,16 @@
     ContextGroundingQueryResponse,
     DeepRagCreationResponse,
     DeepRagResponse,
+    EphemeralIndexUsage,
 )
 from .context_grounding_index import ContextGroundingIndex
 from .context_grounding_payloads import (
+    AttachmentsDataSource,
     BucketDataSource,
     BucketSourceConfig,
     ConfluenceDataSource,
     ConfluenceSourceConfig,
+    CreateEphemeralIndexPayload,
     CreateIndexPayload,
     DropboxDataSource,
     DropboxSourceConfig,
@@ -276,7 +278,6 @@ 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,
@@ -296,11 +297,7 @@ def retrieve_by_id(
         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,
@@ -309,7 +306,6 @@ 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,
@@ -329,11 +325,7 @@ async def retrieve_by_id_async(
         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,
@@ -453,6 +445,66 @@ async def create_index_async(
 
         return ContextGroundingIndex.model_validate(response.json())
 
+    @resource_override(resource_type="index")
+    @traced(name="contextgrounding_create_ephemeral_index", run_type="uipath")
+    def create_ephemeral_index(
+        self,
+        usage: EphemeralIndexUsage,
+        attachments: list[str],
+    ) -> ContextGroundingIndex:
+        """Create a new ephemeral context grounding index.
+
+        Args:
+            usage (EphemeralIndexUsage): The task type for the ephemeral index (DeepRAG or BatchRAG)
+            attachments (list[str]): The list of attachments ids from which the ephemeral index will be created
+
+        Returns:
+            ContextGroundingIndex: The created index information.
+        """
+        spec = self._create_ephemeral_spec(
+            usage,
+            attachments,
+        )
+
+        response = self.request(
+            spec.method,
+            spec.endpoint,
+            json=spec.json,
+            headers=spec.headers,
+        )
+
+        return ContextGroundingIndex.model_validate(response.json())
+
+    @resource_override(resource_type="index")
+    @traced(name="contextgrounding_create_ephemeral_index", run_type="uipath")
+    async def create_ephemeral_index_async(
+        self,
+        usage: EphemeralIndexUsage,
+        attachments: list[str],
+    ) -> ContextGroundingIndex:
+        """Create a new ephemeral context grounding index.
+
+        Args:
+            usage (EphemeralIndexUsage): The task type for the ephemeral index (DeepRAG or BatchRAG)
+            attachments (list[str]): The list of attachments ids from which the ephemeral index will be created
+
+        Returns:
+            ContextGroundingIndex: The created index information.
+        """
+        spec = self._create_ephemeral_spec(
+            usage,
+            attachments,
+        )
+
+        response = await self.request_async(
+            spec.method,
+            spec.endpoint,
+            json=spec.json,
+            headers=spec.headers,
+        )
+
+        return ContextGroundingIndex.model_validate(response.json())
+
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_retrieve_deep_rag", run_type="uipath")
     def retrieve_deep_rag(
@@ -1197,6 +1249,34 @@ def _create_spec(
             },
         )
 
+    def _create_ephemeral_spec(
+        self,
+        usage: str,
+        attachments: list[str],
+    ) -> RequestSpec:
+        """Create request spec for ephemeral index creation.
+
+        Args:
+            usage (str): The task in which the ephemeral index will be used for
+            attachments (list[str]): The list of attachments ids from which the ephemeral index will be created
+
+        Returns:
+            RequestSpec for the create index request
+        """
+        data_source_dict = self._build_ephemeral_data_source(attachments)
+
+        payload = CreateEphemeralIndexPayload(
+            usage=usage,
+            data_source=data_source_dict,
+        )
+
+        return RequestSpec(
+            method="POST",
+            endpoint=Endpoint("/ecs_/v2/indexes/createephemeral"),
+            json=payload.model_dump(by_alias=True, exclude_none=True),
+            headers={},
+        )
+
     def _build_data_source(self, source: SourceConfig) -> Dict[str, Any]:
         """Build data source configuration from typed source config.
 
@@ -1265,14 +1345,29 @@ def _build_data_source(self, source: SourceConfig) -> Dict[str, Any]:
 
         return data_source.model_dump(by_alias=True, exclude_none=True)
 
+    def _build_ephemeral_data_source(self, attachments: list[str]) -> Dict[str, Any]:
+        """Build data source configuration from typed source config.
+
+        Args:
+            attachments (list[str]): The list of attachments ids from which the ephemeral index will be created
+
+        Returns:
+            Dictionary with data source configuration for API
+        """
+        data_source = AttachmentsDataSource(attachments=attachments)
+        return data_source.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            mode="json",
+        )
+
     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)
-
         return RequestSpec(
             method="GET",
             endpoint=Endpoint(f"/ecs_/v2/indexes/{id}"),
@@ -1422,9 +1517,6 @@ def _resolve_folder_key(self, folder_key, folder_path):
                 else None
             )
 
-        if folder_key is None:
-            raise ValueError("ContextGrounding: Failed to resolve folder key")
-
         return folder_key
 
     def _extract_bucket_info(self, index: ContextGroundingIndex) -> Tuple[str, str]:

src/uipath/platform/context_grounding/context_grounding.py

@@ -32,6 +32,13 @@ class CitationMode(str, Enum):
     INLINE = "Inline"
 
 
+class EphemeralIndexUsage(str, Enum):
+    """Enum representing possible ephemeral index usage types."""
+
+    DEEP_RAG = "DeepRAG"
+    BATCH_RAG = "BatchRAG"
+
+
 class DeepRagStatus(str, Enum):
     """Enum representing possible deep RAG tasks status."""
 
@@ -41,6 +48,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."""
 

src/uipath/platform/context_grounding/context_grounding_index.py

@@ -44,9 +44,9 @@ class ContextGroundingIndex(BaseModel):
         extra="allow",
     )
 
-    @field_serializer("last_ingested", "last_queried", when_used="json")
+    @field_serializer("last_ingested", "last_queried")
     def serialize_datetime(self, value):
-        """Serialize datetime fields to ISO 8601 format for JSON output."""
+        """Serialize datetime fields to ISO 8601 format."""
         if isinstance(value, datetime):
             return value.isoformat() if value else None
         return value

src/uipath/platform/context_grounding/context_grounding_payloads.py

@@ -82,6 +82,12 @@ class ConfluenceDataSource(DataSourceBase):
     space_id: str = Field(alias="spaceId", description="Space ID")
 
 
+class AttachmentsDataSource(BaseModel):
+    """Data source configuration for Attachments."""
+
+    attachments: list[str] = Field(description="List of attachment ids")
+
+
 class Indexer(BaseModel):
     """Configuration for periodic indexing of data sources."""
 
@@ -136,6 +142,23 @@ class CreateIndexPayload(BaseModel):
     model_config = ConfigDict(populate_by_name=True)
 
 
+class CreateEphemeralIndexPayload(BaseModel):
+    """Payload for creating an ephemeral context grounding index.
+
+    Note: data_source is Dict[str, Any] because it may contain additional
+    fields like 'indexer' that are added dynamically based on configuration.
+    The data source is still validated through the _build_data_source method
+    which uses typed models internally.
+    """
+
+    usage: str = Field(description="Index usage")
+    data_source: Dict[str, Any] = Field(
+        alias="dataSource", description="Data source configuration"
+    )
+
+    model_config = ConfigDict(populate_by_name=True)
+
+
 # user-facing source configuration models
 class BaseSourceConfig(BaseModel):
     """Base configuration for all source types."""