feat: send current job folder_path on ephemeral index creation [ECS-1745] (#775)

Author: gcuip

pyproject.toml

@@ -7,7 +7,7 @@ requires-python = ">=3.11"
 dependencies = [
     "uipath>=2.10.49, <2.11.0",
     "uipath-core>=0.5.2, <0.6.0",
-    "uipath-platform>=0.1.29, <0.2.0",
+    "uipath-platform>=0.1.30, <0.2.0",
     "uipath-runtime>=0.10.0, <0.11.0",
     "langgraph>=1.0.0, <2.0.0",
     "langchain-core>=1.2.11, <2.0.0",

src/uipath_langchain/agent/tools/internal_tools/batch_transform_tool.py

@@ -25,6 +25,7 @@
 )
 from uipath.runtime.errors import UiPathErrorCategory
 
+from uipath_langchain._utils import get_execution_folder_path
 from uipath_langchain._utils.durable_interrupt import (
     SkipInterruptValue,
     durable_interrupt,
@@ -137,6 +138,7 @@ async def create_ephemeral_index():
                     await uipath.context_grounding.create_ephemeral_index_async(
                         usage=EphemeralIndexUsage.BATCH_RAG,
                         attachments=[attachment_id],
+                        folder_path=get_execution_folder_path(),
                     )
                 )
                 if ephemeral_index.in_progress_ingestion():

src/uipath_langchain/agent/tools/internal_tools/deeprag_tool.py

@@ -21,6 +21,7 @@
 )
 from uipath.runtime.errors import UiPathErrorCategory
 
+from uipath_langchain._utils import get_execution_folder_path
 from uipath_langchain._utils.durable_interrupt import (
     SkipInterruptValue,
     durable_interrupt,
@@ -118,6 +119,7 @@ async def create_ephemeral_index():
                     await uipath.context_grounding.create_ephemeral_index_async(
                         usage=EphemeralIndexUsage.DEEP_RAG,
                         attachments=[attachment_id],
+                        folder_path=get_execution_folder_path(),
                     )
                 )
                 if ephemeral_index.in_progress_ingestion():

tests/agent/tools/internal_tools/test_batch_transform_tool.py

@@ -1,5 +1,6 @@
 """Tests for batch_transform_tool.py module."""
 
+import os
 import uuid
 from unittest.mock import AsyncMock, Mock, patch
 
@@ -547,6 +548,57 @@ async def test_create_batch_transform_tool_custom_destination_path(
             job_key="test-job-key",
         )
 
+    @patch(
+        "uipath_langchain.agent.wrappers.job_attachment_wrapper.get_job_attachment_wrapper"
+    )
+    @patch("uipath_langchain.agent.tools.internal_tools.batch_transform_tool.UiPath")
+    @patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
+    @patch(
+        "uipath_langchain.agent.tools.internal_tools.batch_transform_tool.mockable",
+        lambda **kwargs: lambda f: f,
+    )
+    @patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/TestFolder"})
+    async def test_create_ephemeral_index_passes_folder_path(
+        self,
+        mock_interrupt,
+        mock_uipath_class,
+        mock_get_wrapper,
+        resource_config_static,
+        mock_llm,
+    ):
+        """Test that create_ephemeral_index_async receives folder_path from the execution environment."""
+        mock_uipath = AsyncMock()
+        mock_uipath_class.return_value = mock_uipath
+        mock_uipath_config = Mock()
+        mock_uipath_config.job_key = "test-job-key"
+
+        mock_index = ContextGroundingIndex(
+            id=str(uuid.uuid4()),
+            name="ephemeral-batch-folder",
+            last_ingestion_status="Successful",
+        )
+        mock_uipath.context_grounding.create_ephemeral_index_async = AsyncMock(
+            return_value=mock_index
+        )
+        mock_interrupt.side_effect = [{"file_path": "output.csv"}]
+        mock_uipath.jobs.create_attachment_async = AsyncMock(return_value=uuid.uuid4())
+
+        mock_wrapper = Mock()
+        mock_get_wrapper.return_value = mock_wrapper
+
+        tool = create_batch_transform_tool(resource_config_static, mock_llm)
+        mock_attachment = MockAttachment(
+            ID=str(uuid.uuid4()), FullName="data.csv", MimeType="text/csv"
+        )
+
+        assert tool.coroutine is not None
+        await tool.coroutine(attachment=mock_attachment)
+
+        call_kwargs = (
+            mock_uipath.context_grounding.create_ephemeral_index_async.call_args.kwargs
+        )
+        assert call_kwargs["folder_path"] == "/Shared/TestFolder"
+
     @patch(
         "uipath_langchain.agent.wrappers.job_attachment_wrapper.get_job_attachment_wrapper"
     )

tests/agent/tools/internal_tools/test_deeprag_tool.py

@@ -1,5 +1,6 @@
 """Tests for deeprag_tool.py module."""
 
+import os
 import uuid
 from unittest.mock import AsyncMock, Mock, patch
 
@@ -368,3 +369,51 @@ class AttachmentWithoutID(BaseModel):
         assert tool.coroutine is not None
         with pytest.raises(ValueError, match="Attachment ID is required"):
             await tool.coroutine(attachment=mock_attachment)
+
+    @patch(
+        "uipath_langchain.agent.wrappers.job_attachment_wrapper.get_job_attachment_wrapper"
+    )
+    @patch("uipath_langchain.agent.tools.internal_tools.deeprag_tool.UiPath")
+    @patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
+    @patch(
+        "uipath_langchain.agent.tools.internal_tools.deeprag_tool.mockable",
+        lambda **kwargs: lambda f: f,
+    )
+    @patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/TestFolder"})
+    async def test_create_ephemeral_index_passes_folder_path(
+        self,
+        mock_interrupt,
+        mock_uipath_class,
+        mock_get_wrapper,
+        resource_config_static,
+        mock_llm,
+    ):
+        """Test that create_ephemeral_index_async receives folder_path from the execution environment."""
+        mock_uipath = AsyncMock()
+        mock_uipath_class.return_value = mock_uipath
+
+        mock_index = ContextGroundingIndex(
+            id=str(uuid.uuid4()),
+            name="ephemeral-index-folder",
+            last_ingestion_status="Successful",
+        )
+        mock_uipath.context_grounding.create_ephemeral_index_async = AsyncMock(
+            return_value=mock_index
+        )
+        mock_interrupt.side_effect = [{"text": "result"}]
+
+        mock_wrapper = Mock()
+        mock_get_wrapper.return_value = mock_wrapper
+
+        tool = create_deeprag_tool(resource_config_static, mock_llm)
+        mock_attachment = MockAttachment(
+            ID=str(uuid.uuid4()), FullName="test.pdf", MimeType="application/pdf"
+        )
+
+        assert tool.coroutine is not None
+        await tool.coroutine(attachment=mock_attachment)
+
+        call_kwargs = (
+            mock_uipath.context_grounding.create_ephemeral_index_async.call_args.kwargs
+        )
+        assert call_kwargs["folder_path"] == "/Shared/TestFolder"