uipath 2.0.67__tar.gz → 2.0.69__tar.gz

{uipath-2.0.67 → uipath-2.0.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.67
+Version: 2.0.69
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.0.67 → uipath-2.0.69}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.67"
+version = "2.0.69"
 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.10"

{uipath-2.0.67 → uipath-2.0.69}/src/uipath/_services/context_grounding_service.py

@@ -56,6 +56,7 @@ class ContextGroundingService(FolderContext, BaseService):
         source_path: Optional[str] = None,
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
+        ingest_data: bool = True,
     ) -> None:
         """Add content to the index.
 
@@ -67,6 +68,7 @@ class ContextGroundingService(FolderContext, BaseService):
             source_path (Optional[str]): The source path of the content if it is being uploaded from a file.
             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.
+            ingest_data (bool): Whether to ingest data in the index after content is uploaded. Defaults to True.
 
         Raises:
             ValueError: If neither content nor source_path is provided, or if both are provided.
@@ -94,7 +96,9 @@ class ContextGroundingService(FolderContext, BaseService):
                 folder_path=bucket_folder_path,
                 content_type=content_type,
             )
-        self.ingest_data(index, folder_key=folder_key, folder_path=folder_path)
+
+        if ingest_data:
+            self.ingest_data(index, folder_key=folder_key, folder_path=folder_path)
 
     @traced(name="add_to_index", run_type="uipath")
     @infer_bindings(resource_type="index")
@@ -107,6 +111,7 @@ class ContextGroundingService(FolderContext, BaseService):
         source_path: Optional[str] = None,
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
+        ingest_data: bool = True,
     ) -> None:
         """Asynchronously add content to the index.
 
@@ -118,6 +123,7 @@ class ContextGroundingService(FolderContext, BaseService):
             source_path (Optional[str]): The source path of the content if it is being uploaded from a file.
             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.
+            ingest_data (bool): Whether to ingest data in the index after content is uploaded. Defaults to True.
 
         Raises:
             ValueError: If neither content nor source_path is provided, or if both are provided.
@@ -148,9 +154,10 @@ class ContextGroundingService(FolderContext, BaseService):
                 content_type=content_type,
             )
 
-        await self.ingest_data_async(
-            index, folder_key=folder_key, folder_path=folder_path
-        )
+        if ingest_data:
+            await self.ingest_data_async(
+                index, folder_key=folder_key, folder_path=folder_path
+            )
 
     @traced(name="contextgrounding_retrieve", run_type="uipath")
     @infer_bindings(resource_type="index")

uipath-2.0.69/src/uipath/_services/folder_service.py

@@ -0,0 +1,85 @@
+from typing import Optional
+
+from typing_extensions import deprecated
+
+from uipath.tracing._traced import traced
+
+from .._config import Config
+from .._execution_context import ExecutionContext
+from .._utils import Endpoint, RequestSpec
+from ._base_service import BaseService
+
+
+class FolderService(BaseService):
+    """Service for managing UiPath Folders.
+
+    A folder represents a single area for data organization
+    and access control - it is created when you need to categorize, manage, and enforce authorization rules for a group
+    of UiPath resources (i.e. processes, assets, connections, storage buckets etc.) or other folders
+    """
+
+    def __init__(self, config: Config, execution_context: ExecutionContext) -> None:
+        super().__init__(config=config, execution_context=execution_context)
+
+    @traced(name="folder_retrieve_key_by_folder_path", run_type="uipath")
+    @deprecated("Use retrieve_key instead")
+    def retrieve_key_by_folder_path(self, folder_path: str) -> Optional[str]:
+        return self.retrieve_key(folder_path=folder_path)
+
+    @traced(name="folder_retrieve_key", run_type="uipath")
+    def retrieve_key(self, *, folder_path: str) -> Optional[str]:
+        """Retrieve the folder key by folder path with pagination support.
+
+        Args:
+            folder_path: The fully qualified folder path to search for.
+
+        Returns:
+            The folder key if found, None otherwise.
+        """
+        skip = 0
+        take = 20
+
+        while True:
+            spec = self._retrieve_spec(folder_path, skip=skip, take=take)
+            response = self.request(
+                spec.method,
+                url=spec.endpoint,
+                params=spec.params,
+            ).json()
+
+            # Search for the folder in current page
+            folder_key = next(
+                (
+                    item["Key"]
+                    for item in response["PageItems"]
+                    if item["FullyQualifiedName"] == folder_path
+                ),
+                None,
+            )
+
+            if folder_key is not None:
+                return folder_key
+
+            page_items = response["PageItems"]
+            if len(page_items) < take:
+                break
+
+            skip += take
+
+        return None
+
+    def _retrieve_spec(
+        self, folder_path: str, *, skip: int = 0, take: int = 20
+    ) -> RequestSpec:
+        folder_name = folder_path.split("/")[-1]
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(
+                "orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser"
+            ),
+            params={
+                "searchText": folder_name,
+                "skip": skip,
+                "take": take,
+            },
+        )

{uipath-2.0.67 → uipath-2.0.69}/tests/sdk/services/test_context_grounding_service.py

@@ -38,12 +38,13 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -67,12 +68,13 @@ class TestContextGroundingService:
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -130,12 +132,13 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -159,12 +162,13 @@ class TestContextGroundingService:
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -221,12 +225,13 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -280,17 +285,17 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
         )
-
         httpx_mock.add_response(
             url=f"{base_url}{org}{tenant}/ecs_/v2/indexes?$filter=Name eq 'test-index'&$expand=dataSource",
             status_code=200,

uipath-2.0.69/tests/sdk/services/test_folder_service.py

@@ -0,0 +1,370 @@
+import pytest
+from pytest_httpx import HTTPXMock
+
+from uipath._config import Config
+from uipath._execution_context import ExecutionContext
+from uipath._services.folder_service import FolderService
+from uipath._utils.constants import HEADER_USER_AGENT
+
+
+@pytest.fixture
+def service(
+    config: Config,
+    execution_context: ExecutionContext,
+    monkeypatch: pytest.MonkeyPatch,
+) -> FolderService:
+    monkeypatch.setenv("UIPATH_FOLDER_PATH", "test-folder-path")
+    return FolderService(config=config, execution_context=execution_context)
+
+
+class TestFolderService:
+    def test_retrieve_key_by_folder_path(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
+                    }
+                ]
+            },
+        )
+
+        with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
+            folder_key = service.retrieve_key_by_folder_path("test-folder-path")
+
+        assert folder_key == "test-folder-key"
+
+        sent_request = httpx_mock.get_request()
+        if sent_request is None:
+            raise Exception("No request was sent")
+
+        assert sent_request.method == "GET"
+        assert (
+            sent_request.url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20"
+        )
+
+        assert HEADER_USER_AGENT in sent_request.headers
+        assert (
+            sent_request.headers[HEADER_USER_AGENT]
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.FolderService.retrieve_key/{version}"
+        )
+
+    def test_retrieve_key_by_folder_path_not_found(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&skip=0&take=20",
+            status_code=200,
+            json={"PageItems": []},
+        )
+
+        with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
+            folder_key = service.retrieve_key_by_folder_path("non-existent-folder")
+
+        assert folder_key is None
+
+        sent_request = httpx_mock.get_request()
+        if sent_request is None:
+            raise Exception("No request was sent")
+
+        assert sent_request.method == "GET"
+        assert (
+            sent_request.url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&skip=0&take=20"
+        )
+
+        assert HEADER_USER_AGENT in sent_request.headers
+        assert (
+            sent_request.headers[HEADER_USER_AGENT]
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.FolderService.retrieve_key/{version}"
+        )
+
+    def test_retrieve_key(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
+                    }
+                ]
+            },
+        )
+
+        folder_key = service.retrieve_key(folder_path="test-folder-path")
+
+        assert folder_key == "test-folder-key"
+
+        sent_request = httpx_mock.get_request()
+        if sent_request is None:
+            raise Exception("No request was sent")
+
+        assert sent_request.method == "GET"
+        assert (
+            sent_request.url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20"
+        )
+
+        assert HEADER_USER_AGENT in sent_request.headers
+        assert (
+            sent_request.headers[HEADER_USER_AGENT]
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.FolderService.retrieve_key/{version}"
+        )
+
+    def test_retrieve_key_not_found(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&skip=0&take=20",
+            status_code=200,
+            json={"PageItems": []},
+        )
+
+        folder_key = service.retrieve_key(folder_path="non-existent-folder")
+
+        assert folder_key is None
+
+        sent_request = httpx_mock.get_request()
+        if sent_request is None:
+            raise Exception("No request was sent")
+
+        assert sent_request.method == "GET"
+        assert (
+            sent_request.url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&skip=0&take=20"
+        )
+
+        assert HEADER_USER_AGENT in sent_request.headers
+        assert (
+            sent_request.headers[HEADER_USER_AGENT]
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.FolderService.retrieve_key/{version}"
+        )
+
+    def test_retrieve_key_found_on_second_page(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        """Test that retrieve_key can find a folder on subsequent pages through pagination."""
+        # First page - folder not found
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=target-folder&skip=0&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": f"folder-key-{i}",
+                        "FullyQualifiedName": f"other-folder-{i}",
+                    }
+                    for i in range(20)  # Full page of 20 items, none matching
+                ]
+            },
+        )
+
+        # Second page - folder found
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=target-folder&skip=20&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": "target-folder-key",
+                        "FullyQualifiedName": "target-folder",
+                    },
+                    {
+                        "Key": "another-folder-key",
+                        "FullyQualifiedName": "another-folder",
+                    },
+                ]
+            },
+        )
+
+        folder_key = service.retrieve_key(folder_path="target-folder")
+
+        assert folder_key == "target-folder-key"
+
+        requests = httpx_mock.get_requests()
+        assert len(requests) == 2
+
+        assert requests[0].method == "GET"
+        assert (
+            requests[0].url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=target-folder&skip=0&take=20"
+        )
+
+        assert requests[1].method == "GET"
+        assert (
+            requests[1].url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=target-folder&skip=20&take=20"
+        )
+
+    def test_retrieve_key_not_found_after_pagination(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        """Test that retrieve_key returns None when folder is not found after paginating through all results."""
+        # First page - full page, no match
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=missing-folder&skip=0&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": f"folder-key-{i}",
+                        "FullyQualifiedName": f"other-folder-{i}",
+                    }
+                    for i in range(20)  # Full page of 20 items
+                ]
+            },
+        )
+
+        # Second page - no match
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=missing-folder&skip=20&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": "final-folder-key",
+                        "FullyQualifiedName": "final-folder",
+                    },
+                ]
+            },
+        )
+
+        folder_key = service.retrieve_key(folder_path="missing-folder")
+
+        assert folder_key is None
+
+        requests = httpx_mock.get_requests()
+        assert len(requests) == 2
+
+        assert requests[0].method == "GET"
+        assert (
+            requests[0].url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=missing-folder&skip=0&take=20"
+        )
+
+        assert requests[1].method == "GET"
+        assert (
+            requests[1].url
+            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=missing-folder&skip=20&take=20"
+        )
+
+    def test_retrieve_key_found_on_third_page(
+        self,
+        httpx_mock: HTTPXMock,
+        service: FolderService,
+        base_url: str,
+        org: str,
+        tenant: str,
+        version: str,
+    ) -> None:
+        """Test that retrieve_key can find a folder on the third page through multiple pagination requests."""
+        # First page
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=0&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": f"folder-key-{i}",
+                        "FullyQualifiedName": f"page1-folder-{i}",
+                    }
+                    for i in range(20)
+                ]
+            },
+        )
+
+        # Second page
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=20&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": f"folder-key-{i}",
+                        "FullyQualifiedName": f"page2-folder-{i}",
+                    }
+                    for i in range(20)
+                ]
+            },
+        )
+
+        # Third page - folder found
+        httpx_mock.add_response(
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=40&take=20",
+            status_code=200,
+            json={
+                "PageItems": [
+                    {
+                        "Key": "some-other-key",
+                        "FullyQualifiedName": "some-other-folder",
+                    },
+                    {
+                        "Key": "deep-folder-key",
+                        "FullyQualifiedName": "deep-folder",
+                    },
+                ]
+            },
+        )
+
+        folder_key = service.retrieve_key(folder_path="deep-folder")
+
+        assert folder_key == "deep-folder-key"
+
+        requests = httpx_mock.get_requests()
+        assert len(requests) == 3
+
+        expected_urls = [
+            f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=0&take=20",
+            f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=20&take=20",
+            f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=deep-folder&skip=40&take=20",
+        ]
+
+        for i, request in enumerate(requests):
+            assert request.method == "GET"
+            assert request.url == expected_urls[i]