uipath 2.1.91__py3-none-any.whl → 2.1.93__py3-none-any.whl

uipath/_cli/_push/sw_file_handler.py

@@ -319,7 +319,7 @@ class SwFileHandler:
         if existing:
             try:
                 entry_points_json = (
-                    await self._studio_client.download_file_async(existing.id)
+                    await self._studio_client.download_project_file_async(existing)
                 ).json()
                 entry_points_json["entryPoints"] = uipath_config["entryPoints"]
 
@@ -417,7 +417,7 @@ class SwFileHandler:
         if existing:
             try:
                 existing_agent_json = (
-                    await self._studio_client.download_file_async(existing.id)
+                    await self._studio_client.download_project_file_async(existing)
                 ).json()
                 version_parts = existing_agent_json["metadata"]["codeVersion"].split(
                     "."

uipath/_cli/_runtime/_contracts.py

@@ -8,7 +8,19 @@ import traceback
 from abc import ABC, abstractmethod
 from enum import Enum
 from functools import cached_property
-from typing import Any, Callable, Dict, Generic, List, Optional, Type, TypeVar, Union
+from typing import (
+    Any,
+    AsyncGenerator,
+    Callable,
+    Dict,
+    Generic,
+    List,
+    Literal,
+    Optional,
+    Type,
+    TypeVar,
+    Union,
+)
 from uuid import uuid4
 
 from opentelemetry import context as context_api
@@ -23,6 +35,7 @@ from opentelemetry.sdk.trace.export import (
 from opentelemetry.trace import Tracer
 from pydantic import BaseModel, Field
 
+from uipath._events._events import UiPathRuntimeEvent
 from uipath.agent.conversation import UiPathConversationEvent, UiPathConversationMessage
 from uipath.tracing import TracingManager
 
@@ -143,6 +156,19 @@ class UiPathRuntimeResult(BaseModel):
         return result
 
 
+class UiPathBreakpointResult(UiPathRuntimeResult):
+    """Result for execution suspended at a breakpoint."""
+
+    # Force status to always be SUSPENDED
+    status: UiPathRuntimeStatus = Field(
+        default=UiPathRuntimeStatus.SUSPENDED, frozen=True
+    )
+    breakpoint_node: str  # Which node the breakpoint is at
+    breakpoint_type: Literal["before", "after"]  # Before or after the node
+    current_state: dict[str, Any] | Any  # Current workflow state at breakpoint
+    next_nodes: List[str]  # Which node(s) will execute next
+
+
 class UiPathConversationHandler(ABC):
     """Base delegate for handling UiPath conversation events."""
 
@@ -548,6 +574,47 @@ class UiPathBaseRuntime(ABC):
         """
         pass
 
+    async def stream(
+        self,
+    ) -> AsyncGenerator[Union[UiPathRuntimeEvent, UiPathRuntimeResult], None]:
+        """Stream execution events in real-time.
+
+        This is an optional method that runtimes can implement to support streaming.
+        If not implemented, only the execute() method will be available.
+
+        Yields framework-agnostic BaseEvent instances during execution,
+        with the final event being UiPathRuntimeResult.
+
+        Yields:
+            UiPathRuntimeEvent subclasses: Framework-agnostic events (UiPathAgentMessageEvent,
+                                  UiPathAgentStateEvent, etc.)
+            Final yield: UiPathRuntimeResult (or its subclass UiPathBreakpointResult)
+
+        Raises:
+            NotImplementedError: If the runtime doesn't support streaming
+            RuntimeError: If execution fails
+
+        Example:
+            async for event in runtime.stream():
+                if isinstance(event, UiPathRuntimeResult):
+                    # Last event - execution complete
+                    print(f"Status: {event.status}")
+                    break
+                elif isinstance(event, UiPathAgentMessageEvent):
+                    # Handle message event
+                    print(f"Message: {event.payload}")
+                elif isinstance(event, UiPathAgentStateEvent):
+                    # Handle state update
+                    print(f"State updated by: {event.node_name}")
+        """
+        raise NotImplementedError(
+            f"{self.__class__.__name__} does not implement streaming. "
+            "Use execute() instead."
+        )
+        # This yield is unreachable but makes this a proper generator function
+        # Without it, the function wouldn't match the AsyncGenerator return type
+        yield
+
     @abstractmethod
     async def validate(self):
         """Validate runtime inputs."""

uipath/_cli/_utils/_project_files.py

@@ -557,7 +557,7 @@ async def download_folder_files(
         local_path = base_path / file_path
         local_path.parent.mkdir(parents=True, exist_ok=True)
 
-        response = await studio_client.download_file_async(remote_file.id)
+        response = await studio_client.download_project_file_async(remote_file)
         remote_content = response.read().decode("utf-8")
         remote_hash = compute_normalized_hash(remote_content)
 

uipath/_cli/_utils/_studio_project.py

@@ -8,6 +8,7 @@ from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from uipath._utils.constants import HEADER_SW_LOCK_KEY
 from uipath.models.exceptions import EnrichedException
+from uipath.tracing import traced
 
 
 class ProjectFile(BaseModel):
@@ -231,6 +232,7 @@ class StudioSolutionsClient:
         self.uipath: UiPath = UiPath()
         self._solutions_base_url: str = f"/studio_/backend/api/Solution/{solution_id}"
 
+    @traced(name="create_project", run_type="uipath")
     async def create_project_async(
         self,
         project_name: str,
@@ -275,6 +277,7 @@ class StudioClient:
             f"/studio_/backend/api/Project/{project_id}/Lock"
         )
 
+    @traced(name="get_project_structure", run_type="uipath")
     async def get_project_structure_async(self) -> ProjectStructure:
         """Retrieve the project's file structure from UiPath Cloud.
 
@@ -293,6 +296,7 @@ class StudioClient:
 
         return ProjectStructure.model_validate(response.json())
 
+    @traced(name="create_folder", run_type="uipath")
     @with_lock_retry
     async def create_folder_async(
         self,
@@ -322,6 +326,7 @@ class StudioClient:
         )
         return response.json()
 
+    @traced(name="download_file", run_type="uipath")
     async def download_file_async(self, file_id: str) -> Any:
         response = await self.uipath.api_client.request_async(
             "GET",
@@ -330,6 +335,16 @@ class StudioClient:
         )
         return response
 
+    @traced(name="download_file", run_type="uipath")
+    async def download_project_file_async(self, file: ProjectFile) -> Any:
+        response = await self.uipath.api_client.request_async(
+            "GET",
+            url=f"{self.file_operations_base_url}/File/{file.id}",
+            scoped="org",
+        )
+        return response
+
+    @traced(name="upload_file", run_type="uipath")
     @with_lock_retry
     async def upload_file_async(
         self,
@@ -370,6 +385,7 @@ class StudioClient:
         # response contains only the uploaded file identifier
         return response.json(), action
 
+    @traced(name="delete_file", run_type="uipath")
     @with_lock_retry
     async def delete_item_async(
         self,
@@ -430,6 +446,7 @@ class StudioClient:
 
         return content_bytes, resolved_name
 
+    @traced(name="synchronize_files", run_type="uipath")
     @with_lock_retry
     async def perform_structural_migration_async(
         self,

uipath/_events/_events.py

@@ -1,15 +1,15 @@
-import enum
 import logging
-from typing import Any, List, Optional, Union
+from enum import Enum
+from typing import Any, Dict, List, Optional, Union
 
 from opentelemetry.sdk.trace import ReadableSpan
-from pydantic import BaseModel, ConfigDict, model_validator
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 
 from uipath._cli._evals._models._evaluation_set import EvaluationItem
 from uipath.eval.models import EvalItemResult
 
 
-class EvaluationEvents(str, enum.Enum):
+class EvaluationEvents(str, Enum):
     CREATE_EVAL_SET_RUN = "create_eval_set_run"
     CREATE_EVAL_RUN = "create_eval_run"
     UPDATE_EVAL_SET_RUN = "update_eval_set_run"
@@ -67,3 +67,84 @@ ProgressEvent = Union[
     EvalRunUpdatedEvent,
     EvalSetRunUpdatedEvent,
 ]
+
+
+class EventType(str, Enum):
+    """Types of events that can be emitted during execution."""
+
+    AGENT_MESSAGE = "agent_message"
+    AGENT_STATE = "agent_state"
+    ERROR = "error"
+
+
+class UiPathRuntimeEvent(BaseModel):
+    """Base class for all UiPath runtime events."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    event_type: EventType
+    execution_id: Optional[str] = Field(
+        default=None, description="The runtime execution id associated with the event"
+    )
+    metadata: Optional[Dict[str, Any]] = Field(
+        default=None, description="Additional event context"
+    )
+
+
+class UiPathAgentMessageEvent(UiPathRuntimeEvent):
+    """Event emitted when a message is created or streamed.
+
+    Wraps framework-specific message objects (e.g., LangChain BaseMessage,
+    CrewAI messages, AutoGen messages, etc.) without converting them.
+
+    Attributes:
+        payload: The framework-specific message object
+        event_type: Automatically set to AGENT_MESSAGE
+        metadata: Additional context
+
+    Example:
+        # LangChain
+        event = UiPathAgentMessageEvent(
+            payload=AIMessage(content="Hello"),
+            metadata={"additional_prop": "123"}
+        )
+
+        # Access the message
+        message = event.payload  # BaseMessage
+        print(message.content)
+    """
+
+    payload: Any = Field(description="Framework-specific message object")
+    event_type: EventType = Field(default=EventType.AGENT_MESSAGE, frozen=True)
+
+
+class UiPathAgentStateEvent(UiPathRuntimeEvent):
+    """Event emitted when agent state is updated.
+
+    Wraps framework-specific state update objects, preserving the original
+    structure and data from the framework.
+
+    Attributes:
+        payload: The framework-specific state update (e.g., LangGraph state dict)
+        node_name: Name of the node/agent that produced this update (if available)
+        event_type: Automatically set to AGENT_STATE
+        metadata: Additional context
+
+    Example:
+        # LangGraph
+        event = UiPathAgentStateEvent(
+            payload={"messages": [...], "context": "..."},
+            node_name="agent_node",
+            metadata={"additional_prop": "123"}
+        )
+
+        # Access the state
+        state = event.payload  # dict
+        messages = state.get("messages", [])
+    """
+
+    payload: Dict[str, Any] = Field(description="Framework-specific state update")
+    node_name: Optional[str] = Field(
+        default=None, description="Name of the node/agent that caused this update"
+    )
+    event_type: EventType = Field(default=EventType.AGENT_STATE, frozen=True)

uipath/agent/_utils.py

@@ -29,7 +29,7 @@ async def get_file(
 ) -> Response:
     resolved = resolve_path(folder, path)
     assert isinstance(resolved, ProjectFile), "Path file not found."
-    return await studio_client.download_file_async(resolved.id)
+    return await studio_client.download_project_file_async(resolved)
 
 
 async def create_agent_project(solution_id: str, project_name: str) -> str:

{uipath-2.1.91.dist-info → uipath-2.1.93.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.91
+Version: 2.1.93
 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.1.91.dist-info → uipath-2.1.93.dist-info}/RECORD

@@ -62,8 +62,8 @@ uipath/_cli/_evals/mocks/mocker.py,sha256=VXCxuRAPqUK40kRUXpPmXZRckd7GrOY5ZzIYDe
 uipath/_cli/_evals/mocks/mocker_factory.py,sha256=V5QKSTtQxztTo4-fK1TyAaXw2Z3mHf2UC5mXqwuUGTs,811
 uipath/_cli/_evals/mocks/mockito_mocker.py,sha256=AO2BmFwA6hz3Lte-STVr7aJDPvMCqKNKa4j2jeNZ_U4,2677
 uipath/_cli/_evals/mocks/mocks.py,sha256=HY0IaSqqO8hioBB3rp5XwAjSpQE4K5hoH6oJQ-sH72I,2207
-uipath/_cli/_push/sw_file_handler.py,sha256=sPEopayYzjPNJA6fV9SZZtzE_cdHs1uSszh2IJTB35g,17874
-uipath/_cli/_runtime/_contracts.py,sha256=E8Is7EQfAu7_hCbeZI68gmTxSxo4X7_U4vcSl7D3Syg,28988
+uipath/_cli/_push/sw_file_handler.py,sha256=voZVfJeJTqkvf5aFZvxAHQ_qa7dX_Cz7wRsfhLKL9Ag,17884
+uipath/_cli/_runtime/_contracts.py,sha256=IalIJjLYxNE-0cedRPKcubuXhhVYLOWyN2axGJk6E6o,31436
 uipath/_cli/_runtime/_escalation.py,sha256=x3vI98qsfRA-fL_tNkRVTFXioM5Gv2w0GFcXJJ5eQtg,7981
 uipath/_cli/_runtime/_hitl.py,sha256=VKbM021nVg1HEDnTfucSLJ0LsDn83CKyUtVzofS2qTU,11369
 uipath/_cli/_runtime/_logging.py,sha256=srjAi3Cy6g7b8WNHiYNjaZT4t40F3XRqquuoGd2kh4Y,14019
@@ -83,15 +83,15 @@ uipath/_cli/_utils/_folders.py,sha256=RsYrXzF0NA1sPxgBoLkLlUY3jDNLg1V-Y8j71Q8a8H
 uipath/_cli/_utils/_input_args.py,sha256=AnbQ12D2ACIQFt0QHMaWleRn1ZgRTXuTSTN0ozJiSQg,5766
 uipath/_cli/_utils/_parse_ast.py,sha256=24YL28qK5Ss2O26IlzZ2FgEC_ZazXld_u3vkj8zVxGA,20933
 uipath/_cli/_utils/_processes.py,sha256=q7DfEKHISDWf3pngci5za_z0Pbnf_shWiYEcTOTCiyk,1855
-uipath/_cli/_utils/_project_files.py,sha256=_P42C8wJbN66gJYwt3yAnWsOMqbqFHv80kAoT8UGYuo,20112
-uipath/_cli/_utils/_studio_project.py,sha256=8WYwi_CiTPRqo8KV2bsvj0H_KBFxTEN0Q2cXoZb-NnM,17030
+uipath/_cli/_utils/_project_files.py,sha256=ni5Ex2sOWUtkiM9nlP1E-03L1m9EmORACNXWWXi7Acs,20117
+uipath/_cli/_utils/_studio_project.py,sha256=dlmL5fgfCJzlBffGqAyaxLW50Gzc8SvIsMx-dDFauqs,17782
 uipath/_cli/_utils/_tracing.py,sha256=2igb03j3EHjF_A406UhtCKkPfudVfFPjUq5tXUEG4oo,1541
 uipath/_cli/_utils/_uv_helpers.py,sha256=6SvoLnZPoKIxW0sjMvD1-ENV_HOXDYzH34GjBqwT138,3450
 uipath/_cli/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uipath/_cli/models/runtime_schema.py,sha256=Po1SYFwTBlWZdmwIG2GvFy0WYbZnT5U1aGjfWcd8ZAA,2181
 uipath/_events/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uipath/_events/_event_bus.py,sha256=4-VzstyX69cr7wT1EY7ywp-Ndyz2CyemD3Wk_-QmRpo,5496
-uipath/_events/_events.py,sha256=EzDfzpVm-EIH27Onad5mo8Go6-WB3S6_-6zZQ7qV58w,1811
+uipath/_events/_events.py,sha256=eCgqEP4rzDgZShXMC9wgBVx-AcpwaJZlo2yiL7OyxdA,4441
 uipath/_resources/AGENTS.md,sha256=nRQNAVeEBaBvuMzXw8uXtMnGebLClUgwIMlgb8_qU9o,1039
 uipath/_resources/CLAUDE.md,sha256=kYsckFWTVe948z_fNWLysCHvi9_YpchBXl3s1Ek03lU,10
 uipath/_resources/CLI_REFERENCE.md,sha256=stB6W2aUr0o9UzZ49h7ZXvltaLhnwPUe4_erko4Nr9k,6262
@@ -126,7 +126,7 @@ uipath/_utils/_ssl_context.py,sha256=xSYitos0eJc9cPHzNtHISX9PBvL6D2vas5G_GiBdLp8
 uipath/_utils/_url.py,sha256=-4eluSrIZCUlnQ3qU17WPJkgaC2KwF9W5NeqGnTNGGo,2512
 uipath/_utils/_user_agent.py,sha256=pVJkFYacGwaQBomfwWVAvBQgdBUo62e4n3-fLIajWUU,563
 uipath/_utils/constants.py,sha256=2xLT-1aW0aJS2USeZbK-7zRgyyi1bgV60L0rtQOUqOM,1721
-uipath/agent/_utils.py,sha256=ec0FJV95pujbMaa0_Vz1nX1fAHp64nJKbf4tYbQn-aI,5560
+uipath/agent/_utils.py,sha256=eZJRC2-G-T9vBn62O9Gy6Qipt-5RA5iMIynZTbIQoBA,5565
 uipath/agent/conversation/__init__.py,sha256=5hK-Iz131mnd9m6ANnpZZffxXZLVFDQ9GTg5z9ik1oQ,5265
 uipath/agent/conversation/async_stream.py,sha256=BA_8uU1DgE3VpU2KkJj0rkI3bAHLk_ZJKsajR0ipMpo,2055
 uipath/agent/conversation/citation.py,sha256=42dGv-wiYx3Lt7MPuPCFTkjAlSADFSzjyNXuZHdxqvo,2253
@@ -184,8 +184,8 @@ uipath/tracing/_utils.py,sha256=X-LFsyIxDeNOGuHPvkb6T5o9Y8ElYhr_rP3CEBJSu4s,1383
 uipath/utils/__init__.py,sha256=VD-KXFpF_oWexFg6zyiWMkxl2HM4hYJMIUDZ1UEtGx0,105
 uipath/utils/_endpoints_manager.py,sha256=iRTl5Q0XAm_YgcnMcJOXtj-8052sr6jpWuPNz6CgT0Q,8408
 uipath/utils/dynamic_schema.py,sha256=w0u_54MoeIAB-mf3GmwX1A_X8_HDrRy6p998PvX9evY,3839
-uipath-2.1.91.dist-info/METADATA,sha256=4qk08PijcX8XCNXQJLdjg27DadfbidSqDiY5YWUc734,6593
-uipath-2.1.91.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.1.91.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.1.91.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.1.91.dist-info/RECORD,,
+uipath-2.1.93.dist-info/METADATA,sha256=TbFA1C7aF3D8rpFAJ8GAjkEgQeTa8BRSn8NPVX1q3_U,6593
+uipath-2.1.93.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.1.93.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.1.93.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.1.93.dist-info/RECORD,,