Init

Author: GabrielVasilescu04

src/uipath/_services/__init__.py

@@ -5,6 +5,7 @@
 from .buckets_service import BucketsService
 from .connections_service import ConnectionsService
 from .context_grounding_service import ContextGroundingService
+from .entities_service import EntitiesService
 from .folder_service import FolderService
 from .jobs_service import JobsService
 from .llm_gateway_service import UiPathLlmChatService, UiPathOpenAIService
@@ -25,4 +26,5 @@
     "UiPathOpenAIService",
     "UiPathLlmChatService",
     "FolderService",
+    "EntitiesService"
 ]

src/uipath/_services/entities_service.py

@@ -0,0 +1,124 @@
+from typing import List, Optional, Type, TypeVar
+
+from pydantic import ValidationError, BaseModel
+
+from .._config import Config
+from .._execution_context import ExecutionContext
+from ._base_service import BaseService
+from .._utils import infer_bindings, RequestSpec, Endpoint, header_folder
+from ..models.entities import EntityGetByIdResponse, EntityRecord
+from ..tracing import traced
+
+T = TypeVar("T", bound=BaseModel)
+
+class EntitiesService(BaseService):
+
+    def __init__(
+        self,
+        config: Config,
+        execution_context: ExecutionContext
+    ) -> None:
+        super().__init__(config=config, execution_context=execution_context)
+
+    @traced(name="entity_retrieve", run_type="uipath")
+    def retrieve(
+        self,
+        entity_key: str) -> EntityGetByIdResponse:
+
+        spec = self._retrieve_spec(entity_key)
+        response = self.request(spec.method, spec.endpoint)
+
+        return EntityGetByIdResponse.model_validate(response.json())
+
+    @traced(name="entity_retrieve", run_type="uipath")
+    async def retrieve_async(
+        self,
+        entity_key: str) -> EntityGetByIdResponse:
+        spec = self._retrieve_spec(entity_key)
+
+        response = await self.request_async(spec.method, spec.endpoint)
+
+        return  EntityGetByIdResponse.model_validate(response.json())
+
+    @traced(name="entity_list_records", run_type="uipath")
+    def list_records(
+        self,
+        entity_key: str,
+        schema: Optional[Type[T]] = None,  # Optional schema
+        start: Optional[int] = None,
+        limit: Optional[int] = None
+    ) -> List[EntityRecord]:
+
+        # Example method to generate the API request specification (mocked here)
+        spec = self._list_records_spec(entity_key, start, limit)
+
+        # Make the HTTP request (assumes self.request exists)
+        response = self.request(spec.method, spec.endpoint)
+
+        # Parse the response JSON and extract the "value" field
+        records_data = response.json().get("value", [])
+
+        # Validate and wrap records
+        validated_records = []
+        for record in records_data:
+            try:
+                # Validate & wrap the record using EntityRecord.from_data
+                validated_record = EntityRecord.from_data(data=record, model=schema)
+                validated_records.append(validated_record)
+            except ValueError as e:
+                print(f"Failed to validate record: {record} => {e}")
+                continue
+
+        return validated_records
+
+    def _retrieve_spec(
+        self,
+        entity_key: str,
+    ) -> RequestSpec:
+
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(f"datafabric_/api/Entity/{entity_key}"),
+        )
+
+    def _list_records_spec(
+        self,
+        entity_key: str,
+        start: Optional[int] = None,
+        limit: Optional[int] = None,
+    ) -> RequestSpec:
+
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(f"datafabric_/api/EntityService/entity/{entity_key}/read?start={start}&limit={limit}"),
+        )
+
+    def _create_spec(
+        self,
+        entity_key: str,
+    ) -> RequestSpec:
+
+        return RequestSpec(
+            method="POST",
+            endpoint=Endpoint(f"datafabric_/api/EntityService/entity/{entity_key}/insert-batch"),
+        )
+
+    def _update_spec(
+        self,
+        entity_key: str,
+    ) -> RequestSpec:
+
+        return RequestSpec(
+            method="PUT",
+            endpoint=Endpoint(f"datafabric_/api/EntityService/entity/{entity_key}/update-batch"),
+        )
+
+    def _delete_spec(
+        self,
+        entity_key: str,
+    ) -> RequestSpec:
+
+        return RequestSpec(
+            method="DELETE",
+            endpoint=Endpoint(f"datafabric_/api/EntityService/entity/{entity_key}/delete-batch"),
+        )

src/uipath/_uipath.py

@@ -20,6 +20,7 @@
     QueuesService,
     UiPathLlmChatService,
     UiPathOpenAIService,
+    EntitiesService
 )
 from ._utils import setup_logging
 from ._utils.constants import (
@@ -132,3 +133,7 @@ def llm_openai(self) -> UiPathOpenAIService:
     @property
     def llm(self) -> UiPathLlmChatService:
         return UiPathLlmChatService(self._config, self._execution_context)
+
+    @property
+    def entities(self) -> EntitiesService:
+        return EntitiesService(self._config, self._execution_context)