feat: replace conversation interrupts with tool call confirmation [JAR-8666]

Author: JoshParkSJ

.github/scripts/test_check_version_uniqueness.py

@@ -5,7 +5,6 @@
 import urllib.error
 from unittest import mock
 
-import pytest
 
 from check_version_uniqueness import (
     get_package_info,

packages/uipath-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-core"
-version = "0.5.11"
+version = "0.5.12"
 description = "UiPath Core abstractions"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-core/src/uipath/core/chat/__init__.py

@@ -77,20 +77,6 @@
     UiPathConversationExchangeEvent,
     UiPathConversationExchangeStartEvent,
 )
-from .interrupt import (
-    InterruptTypeEnum,
-    UiPathConversationGenericInterruptEndEvent,
-    UiPathConversationGenericInterruptStartEvent,
-    UiPathConversationInterrupt,
-    UiPathConversationInterruptData,
-    UiPathConversationInterruptEndEvent,
-    UiPathConversationInterruptEvent,
-    UiPathConversationInterruptStartEvent,
-    UiPathConversationToolCallConfirmationEndValue,
-    UiPathConversationToolCallConfirmationInterruptEndEvent,
-    UiPathConversationToolCallConfirmationInterruptStartEvent,
-    UiPathConversationToolCallConfirmationValue,
-)
 from .message import (
     UiPathConversationMessage,
     UiPathConversationMessageData,
@@ -108,6 +94,7 @@
 )
 from .tool import (
     UiPathConversationToolCall,
+    UiPathConversationToolCallConfirmation,
     UiPathConversationToolCallData,
     UiPathConversationToolCallEndEvent,
     UiPathConversationToolCallEvent,
@@ -141,19 +128,6 @@
     "UiPathConversationMessageEvent",
     "UiPathConversationMessageData",
     "UiPathConversationMessage",
-    # Interrupt
-    "InterruptTypeEnum",
-    "UiPathConversationInterruptStartEvent",
-    "UiPathConversationInterruptEndEvent",
-    "UiPathConversationInterruptEvent",
-    "UiPathConversationToolCallConfirmationValue",
-    "UiPathConversationToolCallConfirmationEndValue",
-    "UiPathConversationToolCallConfirmationInterruptStartEvent",
-    "UiPathConversationToolCallConfirmationInterruptEndEvent",
-    "UiPathConversationGenericInterruptStartEvent",
-    "UiPathConversationGenericInterruptEndEvent",
-    "UiPathConversationInterruptData",
-    "UiPathConversationInterrupt",
     # Content
     "UiPathConversationContentPartChunkEvent",
     "UiPathConversationContentPartStartEvent",
@@ -178,6 +152,7 @@
     # Tool
     "UiPathConversationToolCallStartEvent",
     "UiPathConversationToolCallEndEvent",
+    "UiPathConversationToolCallConfirmation",
     "UiPathConversationToolCallEvent",
     "UiPathConversationToolCallResult",
     "UiPathConversationToolCallData",

packages/uipath-core/src/uipath/core/chat/interrupt.py

@@ -10,11 +10,6 @@
     UiPathConversationContentPartEvent,
 )
 from .error import UiPathConversationErrorEvent
-from .interrupt import (
-    UiPathConversationInterrupt,
-    UiPathConversationInterruptData,
-    UiPathConversationInterruptEvent,
-)
 from .tool import (
     UiPathConversationToolCall,
     UiPathConversationToolCallData,
@@ -53,7 +48,6 @@ class UiPathConversationMessageEvent(BaseModel):
         None, alias="contentPart"
     )
     tool_call: UiPathConversationToolCallEvent | None = Field(None, alias="toolCall")
-    interrupt: UiPathConversationInterruptEvent | None = None
     meta_event: dict[str, Any] | None = Field(None, alias="metaEvent")
     error: UiPathConversationErrorEvent | None = Field(None, alias="messageError")
 
@@ -68,7 +62,6 @@ class UiPathConversationMessageData(BaseModel):
         ..., alias="contentParts"
     )
     tool_calls: Sequence[UiPathConversationToolCallData] = Field(..., alias="toolCalls")
-    interrupts: Sequence[UiPathConversationInterruptData]
 
     model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)
 
@@ -86,6 +79,5 @@ class UiPathConversationMessage(UiPathConversationMessageData):
         ..., alias="contentParts"
     )
     tool_calls: Sequence[UiPathConversationToolCall] = Field(..., alias="toolCalls")
-    interrupts: Sequence[UiPathConversationInterrupt]
 
     model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)

packages/uipath-core/src/uipath/core/chat/message.py

@@ -25,6 +25,8 @@ class UiPathConversationToolCallStartEvent(BaseModel):
     timestamp: str | None = None
     input: dict[str, Any] | None = None
     metadata: dict[str, Any] | None = Field(None, alias="metaData")
+    require_confirmation: bool | None = Field(None, alias="requireConfirmation")
+    input_schema: Any | None = Field(None, alias="inputSchema")
 
     model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)
 
@@ -41,6 +43,16 @@ class UiPathConversationToolCallEndEvent(BaseModel):
     model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)
 
 
+class UiPathConversationToolCallConfirmation(BaseModel):
+    """Represents a tool call confirmation (approve/reject)."""
+
+    approved: bool
+    input: Any | None = None
+    confirmed_at: str | None = Field(None, alias="confirmedAt")
+
+    model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)
+
+
 class UiPathConversationToolCallEvent(BaseModel):
     """Encapsulates the data related to a tool call event."""
 
@@ -49,6 +61,9 @@ class UiPathConversationToolCallEvent(BaseModel):
         None, alias="startToolCall"
     )
     end: UiPathConversationToolCallEndEvent | None = Field(None, alias="endToolCall")
+    confirm: UiPathConversationToolCallConfirmation | None = Field(
+        None, alias="confirmToolCall"
+    )
     meta_event: dict[str, Any] | None = Field(None, alias="metaEvent")
     error: UiPathConversationErrorEvent | None = Field(None, alias="toolCallError")
 
@@ -61,6 +76,9 @@ class UiPathConversationToolCallData(BaseModel):
     name: str
     input: dict[str, Any] | None = None
     result: UiPathConversationToolCallResult | None = None
+    require_confirmation: bool | None = Field(None, alias="requireConfirmation")
+    input_schema: Any | None = Field(None, alias="inputSchema")
+    confirmation: UiPathConversationToolCallConfirmation | None = None
 
     model_config = ConfigDict(validate_by_name=True, validate_by_alias=True)
 

packages/uipath-core/src/uipath/core/chat/tool.py

@@ -38,7 +38,6 @@ async def test_retrieve_message(
                     "role": "assistant",
                     "contentParts": [],
                     "toolCalls": [],
-                    "interrupts": [],
                     "createdAt": "2024-01-01T00:00:00Z",
                     "updatedAt": "2024-01-01T00:00:00Z",
                 },
@@ -95,7 +94,6 @@ async def test_retrieve_message_with_content_parts(
                         }
                     ],
                     "toolCalls": [],
-                    "interrupts": [],
                     "createdAt": "2024-01-01T00:00:00Z",
                     "updatedAt": "2024-01-01T00:00:00Z",
                 },
@@ -145,7 +143,6 @@ async def test_retrieve_message_with_tool_calls(
                             "updatedAt": "2024-01-01T00:00:00Z",
                         }
                     ],
-                    "interrupts": [],
                     "createdAt": "2024-01-01T00:00:00Z",
                     "updatedAt": "2024-01-01T00:00:00Z",
                 },

packages/uipath-core/uv.lock

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.10.48"
+version = "2.10.49"
 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.11"