uipath 2.1.91__tar.gz → 2.1.92__tar.gz

{uipath-2.1.91 → uipath-2.1.92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.91
+Version: 2.1.92
 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 → uipath-2.1.92}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.91"
+version = "2.1.92"
 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.1.91 → uipath-2.1.92}/src/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-2.1.91 → uipath-2.1.92}/src/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 BaseEvent
 from uipath.agent.conversation import UiPathConversationEvent, UiPathConversationMessage
 from uipath.tracing import TracingManager
 
@@ -143,6 +156,19 @@ class UiPathRuntimeResult(BaseModel):
         return result
 
 
+class UiPathRuntimeBreakpointResult(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[BaseEvent, 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:
+            BaseEvent subclasses: Framework-agnostic events (MessageCreatedEvent,
+                                  AgentStateUpdatedEvent, etc.)
+            Final yield: UiPathRuntimeResult
+
+        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, MessageCreatedEvent):
+                    # Handle message event
+                    print(f"Message: {event.payload}")
+                elif isinstance(event, AgentStateUpdatedEvent):
+                    # 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-2.1.91 → uipath-2.1.92}/src/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-2.1.91 → uipath-2.1.92}/src/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-2.1.92/src/uipath/_events/_events.py

@@ -0,0 +1,147 @@
+import logging
+from enum import Enum
+from typing import Any, Dict, List, Optional, Union
+
+from opentelemetry.sdk.trace import ReadableSpan
+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):
+    CREATE_EVAL_SET_RUN = "create_eval_set_run"
+    CREATE_EVAL_RUN = "create_eval_run"
+    UPDATE_EVAL_SET_RUN = "update_eval_set_run"
+    UPDATE_EVAL_RUN = "update_eval_run"
+
+
+class EvalSetRunCreatedEvent(BaseModel):
+    execution_id: str
+    entrypoint: str
+    eval_set_id: str
+    no_of_evals: int
+    evaluators: List[Any]
+
+
+class EvalRunCreatedEvent(BaseModel):
+    execution_id: str
+    eval_item: EvaluationItem
+
+
+class EvalItemExceptionDetails(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    runtime_exception: bool = False
+    exception: Exception
+
+
+class EvalRunUpdatedEvent(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    execution_id: str
+    eval_item: EvaluationItem
+    eval_results: List[EvalItemResult]
+    success: bool
+    agent_output: Any
+    agent_execution_time: float
+    spans: List[ReadableSpan]
+    logs: List[logging.LogRecord]
+    exception_details: Optional[EvalItemExceptionDetails] = None
+
+    @model_validator(mode="after")
+    def validate_exception_details(self):
+        if not self.success and self.exception_details is None:
+            raise ValueError("exception_details must be provided when success is False")
+        return self
+
+
+class EvalSetRunUpdatedEvent(BaseModel):
+    execution_id: str
+    evaluator_scores: dict[str, float]
+
+
+ProgressEvent = Union[
+    EvalSetRunCreatedEvent,
+    EvalRunCreatedEvent,
+    EvalRunUpdatedEvent,
+    EvalSetRunUpdatedEvent,
+]
+
+
+class EventType(str, Enum):
+    """Types of events that can be emitted during execution."""
+
+    MESSAGE_CREATED = "message_created"
+    AGENT_STATE_UPDATED = "agent_state_updated"
+    ERROR = "error"
+
+
+class BaseEvent(BaseModel):
+    """Base class for all UiPath events."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    event_type: EventType
+    metadata: Optional[Dict[str, Any]] = Field(
+        default=None, description="Additional event context"
+    )
+
+
+class MessageCreatedEvent(BaseEvent):
+    """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 MESSAGE_CREATED
+        metadata: Additional context (conversation_id, exchange_id, etc.)
+
+    Example:
+        # LangChain
+        event = MessageCreatedEvent(
+            payload=AIMessage(content="Hello"),
+            metadata={"conversation_id": "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.MESSAGE_CREATED, frozen=True)
+
+
+class AgentStateUpdatedEvent(BaseEvent):
+    """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_UPDATED
+        metadata: Additional context
+
+    Example:
+        # LangGraph
+        event = AgentStateUpdatedEvent(
+            payload={"messages": [...], "context": "..."},
+            node_name="agent_node",
+            metadata={"conversation_id": "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_UPDATED, frozen=True)

{uipath-2.1.91 → uipath-2.1.92}/src/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 → uipath-2.1.92}/uv.lock

@@ -2146,7 +2146,7 @@ wheels = [
 
 [[package]]
 name = "uipath"
-version = "2.1.91"
+version = "2.1.92"
 source = { editable = "." }
 dependencies = [
     { name = "azure-monitor-opentelemetry" },

uipath-2.1.91/src/uipath/_events/_events.py

@@ -1,69 +0,0 @@
-import enum
-import logging
-from typing import Any, List, Optional, Union
-
-from opentelemetry.sdk.trace import ReadableSpan
-from pydantic import BaseModel, ConfigDict, model_validator
-
-from uipath._cli._evals._models._evaluation_set import EvaluationItem
-from uipath.eval.models import EvalItemResult
-
-
-class EvaluationEvents(str, enum.Enum):
-    CREATE_EVAL_SET_RUN = "create_eval_set_run"
-    CREATE_EVAL_RUN = "create_eval_run"
-    UPDATE_EVAL_SET_RUN = "update_eval_set_run"
-    UPDATE_EVAL_RUN = "update_eval_run"
-
-
-class EvalSetRunCreatedEvent(BaseModel):
-    execution_id: str
-    entrypoint: str
-    eval_set_id: str
-    no_of_evals: int
-    evaluators: List[Any]
-
-
-class EvalRunCreatedEvent(BaseModel):
-    execution_id: str
-    eval_item: EvaluationItem
-
-
-class EvalItemExceptionDetails(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-
-    runtime_exception: bool = False
-    exception: Exception
-
-
-class EvalRunUpdatedEvent(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-
-    execution_id: str
-    eval_item: EvaluationItem
-    eval_results: List[EvalItemResult]
-    success: bool
-    agent_output: Any
-    agent_execution_time: float
-    spans: List[ReadableSpan]
-    logs: List[logging.LogRecord]
-    exception_details: Optional[EvalItemExceptionDetails] = None
-
-    @model_validator(mode="after")
-    def validate_exception_details(self):
-        if not self.success and self.exception_details is None:
-            raise ValueError("exception_details must be provided when success is False")
-        return self
-
-
-class EvalSetRunUpdatedEvent(BaseModel):
-    execution_id: str
-    evaluator_scores: dict[str, float]
-
-
-ProgressEvent = Union[
-    EvalSetRunCreatedEvent,
-    EvalRunCreatedEvent,
-    EvalRunUpdatedEvent,
-    EvalSetRunUpdatedEvent,
-]