feat(context-grounding): expose index_id on UnifiedQueryResult

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.1.16"
+version = "0.1.17"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-platform/src/uipath/platform/context_grounding/_context_grounding_service.py

@@ -785,7 +785,9 @@ def start_batch_transform(
             params=spec.params,
             headers=spec.headers,
         )
-        return BatchTransformCreationResponse.model_validate(response.json())
+        result = BatchTransformCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id)
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_batch_transform_async", run_type="uipath")
@@ -861,7 +863,9 @@ async def start_batch_transform_async(
             params=spec.params,
             headers=spec.headers,
         )
-        return BatchTransformCreationResponse.model_validate(response.json())
+        result = BatchTransformCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id)
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_batch_transform", run_type="uipath")
@@ -907,7 +911,9 @@ async def start_batch_transform_ephemeral(
             params=spec.params,
             headers=spec.headers,
         )
-        return BatchTransformCreationResponse.model_validate(response.json())
+        result = BatchTransformCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id) if index_id else None
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_batch_transform_async", run_type="uipath")
@@ -953,7 +959,9 @@ async def start_batch_transform_ephemeral_async(
             params=spec.params,
             headers=spec.headers,
         )
-        return BatchTransformCreationResponse.model_validate(response.json())
+        result = BatchTransformCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id) if index_id else None
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_retrieve_batch_transform", run_type="uipath")
@@ -1185,7 +1193,9 @@ def start_deep_rag(
             headers=spec.headers,
         )
 
-        return DeepRagCreationResponse.model_validate(response.json())
+        result = DeepRagCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id)
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_deep_rag_async", run_type="uipath")
@@ -1248,7 +1258,9 @@ async def start_deep_rag_async(
             headers=spec.headers,
         )
 
-        return DeepRagCreationResponse.model_validate(response.json())
+        result = DeepRagCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id)
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_deep_rag", run_type="uipath")
@@ -1289,7 +1301,9 @@ async def start_deep_rag_ephemeral(
             headers=spec.headers,
         )
 
-        return DeepRagCreationResponse.model_validate(response.json())
+        result = DeepRagCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id) if index_id else None
+        return result
 
     @resource_override(resource_type="index", resource_identifier="index_name")
     @traced(name="contextgrounding_start_deep_rag_async", run_type="uipath")
@@ -1330,7 +1344,9 @@ async def start_deep_rag_ephemeral_async(
             headers=spec.headers,
         )
 
-        return DeepRagCreationResponse.model_validate(response.json())
+        result = DeepRagCreationResponse.model_validate(response.json())
+        result.index_id = str(index_id) if index_id else None
+        return result
 
     @resource_override(resource_type="index")
     @traced(name="contextgrounding_search", run_type="uipath")
@@ -1503,7 +1519,9 @@ def unified_search(
             headers=spec.headers,
         )
 
-        return UnifiedQueryResult.model_validate(response.json())
+        result = UnifiedQueryResult.model_validate(response.json())
+        result.index_id = str(index.id)
+        return result
 
     @resource_override(resource_type="index")
     @traced(name="contextgrounding_unified_search", run_type="uipath")
@@ -1562,7 +1580,9 @@ async def unified_search_async(
             headers=spec.headers,
         )
 
-        return UnifiedQueryResult.model_validate(response.json())
+        result = UnifiedQueryResult.model_validate(response.json())
+        result.index_id = str(index.id)
+        return result
 
     @traced(name="contextgrounding_ingest_data", run_type="uipath")
     def ingest_data(

packages/uipath-platform/src/uipath/platform/context_grounding/context_grounding.py

@@ -128,6 +128,7 @@ class BatchTransformCreationResponse(BaseModel):
     id: str
     last_batch_rag_status: DeepRagStatus = Field(alias="lastBatchRagStatus")
     error_message: str | None = Field(alias="errorMessage", default=None)
+    index_id: Optional[str] = Field(default=None, alias="indexId")
 
 
 class BatchTransformResponse(BaseModel):
@@ -175,6 +176,7 @@ class DeepRagCreationResponse(BaseModel):
     id: str
     last_deep_rag_status: DeepRagStatus = Field(alias="lastDeepRagStatus")
     created_date: str = Field(alias="createdDate")
+    index_id: Optional[str] = Field(default=None, alias="indexId")
 
 
 class ContextGroundingMetadata(BaseModel):
@@ -305,3 +307,4 @@ class UnifiedQueryResult(BaseModel):
         default=None, alias="semanticResults"
     )
     explanation: Optional[str] = Field(default=None)
+    index_id: Optional[str] = Field(default=None, alias="indexId")