feat: make _retrieve_system_indexes private

Author: gcuip

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

@@ -258,23 +258,10 @@ async def retrieve_across_folders_async(
         ]
 
     @traced(name="contextgrounding_retrieve_system_indexes", run_type="uipath")
-    def retrieve_system_indexes(
+    def _retrieve_system_indexes(
         self,
         name: Optional[str] = None,
     ) -> List[ContextGroundingIndex]:
-        """Retrieve tenant-wide system context grounding indexes.
-
-        System indexes are shared across all folders and tenants and do not
-        require a folder key. They are typically used by bundled StudioWeb
-        templates that reference shared indexes.
-
-        Args:
-            name (Optional[str]): Optional name filter. If provided, only indexes
-                matching this name will be returned.
-
-        Returns:
-            List[ContextGroundingIndex]: A list of system indexes.
-        """
         spec = self._retrieve_system_indexes_spec(name=name)
 
         response = self.request(
@@ -288,23 +275,10 @@ def retrieve_system_indexes(
         ]
 
     @traced(name="contextgrounding_retrieve_system_indexes", run_type="uipath")
-    async def retrieve_system_indexes_async(
+    async def _retrieve_system_indexes_async(
         self,
         name: Optional[str] = None,
     ) -> List[ContextGroundingIndex]:
-        """Asynchronously retrieve tenant-wide system context grounding indexes.
-
-        System indexes are shared across all folders and tenants and do not
-        require a folder key. They are typically used by bundled StudioWeb
-        templates that reference shared indexes.
-
-        Args:
-            name (Optional[str]): Optional name filter. If provided, only indexes
-                matching this name will be returned.
-
-        Returns:
-            List[ContextGroundingIndex]: A list of system indexes.
-        """
         spec = self._retrieve_system_indexes_spec(name=name)
 
         response = (
@@ -446,7 +420,7 @@ async def retrieve_async(
             raise ContextGroundingIndexNotFoundError(name) from None
 
     def _retrieve_from_system_indexes(self, name: str) -> ContextGroundingIndex:
-        indexes = self.retrieve_system_indexes(name=name)
+        indexes = self._retrieve_system_indexes(name=name)
         try:
             return next(index for index in indexes if index.name == name)
         except StopIteration:
@@ -455,7 +429,7 @@ def _retrieve_from_system_indexes(self, name: str) -> ContextGroundingIndex:
     async def _retrieve_from_system_indexes_async(
         self, name: str
     ) -> ContextGroundingIndex:
-        indexes = await self.retrieve_system_indexes_async(name=name)
+        indexes = await self._retrieve_system_indexes_async(name=name)
         try:
             return next(index for index in indexes if index.name == name)
         except StopIteration:

packages/uipath-platform/tests/services/test_context_grounding_service.py

@@ -790,7 +790,7 @@ def test_retrieve_system_indexes(
             },
         )
 
-        indexes = service.retrieve_system_indexes()
+        indexes = service._retrieve_system_indexes()
 
         assert isinstance(indexes, list)
         assert len(indexes) == 2
@@ -806,7 +806,7 @@ def test_retrieve_system_indexes(
         assert HEADER_USER_AGENT in sent_requests[0].headers
         assert (
             sent_requests[0].headers[HEADER_USER_AGENT]
-            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.ContextGroundingService.retrieve_system_indexes/{version}"
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.ContextGroundingService._retrieve_system_indexes/{version}"
         )
 
     def test_retrieve_system_indexes_with_name_filter(
@@ -831,7 +831,7 @@ def test_retrieve_system_indexes_with_name_filter(
             },
         )
 
-        indexes = service.retrieve_system_indexes(name="system-template-index")
+        indexes = service._retrieve_system_indexes(name="system-template-index")
 
         assert len(indexes) == 1
         assert indexes[0].name == "system-template-index"
@@ -864,7 +864,7 @@ async def test_retrieve_system_indexes_async(
             },
         )
 
-        indexes = await service.retrieve_system_indexes_async()
+        indexes = await service._retrieve_system_indexes_async()
 
         assert len(indexes) == 1
         assert indexes[0].id == "sys-index-1"
@@ -876,7 +876,7 @@ async def test_retrieve_system_indexes_async(
 
         assert (
             sent_requests[0].headers[HEADER_USER_AGENT]
-            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.ContextGroundingService.retrieve_system_indexes_async/{version}"
+            == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.ContextGroundingService._retrieve_system_indexes_async/{version}"
         )
 
     def test_retrieve_system_indexes_escapes_single_quote_in_name(
@@ -901,7 +901,7 @@ def test_retrieve_system_indexes_escapes_single_quote_in_name(
             },
         )
 
-        indexes = service.retrieve_system_indexes(name="O'Brien")
+        indexes = service._retrieve_system_indexes(name="O'Brien")
 
         assert len(indexes) == 1
         assert indexes[0].name == "O'Brien"
@@ -947,7 +947,7 @@ def test_retrieve_system_indexes_empty(
             json={"value": []},
         )
 
-        indexes = service.retrieve_system_indexes()
+        indexes = service._retrieve_system_indexes()
 
         assert indexes == []