feat: allow conversational agents to optionally end exchange [JAR-9933]

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-runtime"
-version = "0.11.0"
+version = "0.12.0"
 description = "Runtime abstractions and interfaces for building agents and automation scripts in the UiPath ecosystem"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath/runtime/chat/runtime.py

@@ -35,16 +35,20 @@ def __init__(
         self,
         delegate: UiPathRuntimeProtocol,
         chat_bridge: UiPathChatProtocol,
+        end_exchange: bool = True,
     ):
         """Initialize the UiPathChatRuntime.
 
         Args:
             delegate: The underlying runtime to wrap
             chat_bridge: Bridge for chat event communication
+            end_exchange: Whether to emit the exchange end event. When False, the exchange is left open so a
+                downstream consumer can continue it and end it later.
         """
         super().__init__()
         self.delegate = delegate
         self.chat_bridge = chat_bridge
+        self.end_exchange = end_exchange
 
     async def execute(
         self,
@@ -167,7 +171,8 @@ async def stream(
                         else:
                             yield event
                             execution_completed = True
-                            await self.chat_bridge.emit_exchange_end_event()
+                            if self.end_exchange:
+                                await self.chat_bridge.emit_exchange_end_event()
                     else:
                         yield event
 

src/uipath/runtime/context.py

@@ -37,6 +37,10 @@ class UiPathRuntimeContext(BaseModel):
     )
     exchange_id: str | None = Field(None, description="Exchange identifier for CAS")
     message_id: str | None = Field(None, description="Message identifier for CAS")
+    end_exchange: bool = Field(
+        True,
+        description="Whether to emit the exchange end event for CAS",
+    )
     voice_mode: Literal["session"] | None = Field(
         None, description="Voice job type for CAS"
     )
@@ -364,6 +368,7 @@ def from_config(
             "conversationalService.conversationId": "conversation_id",
             "conversationalService.exchangeId": "exchange_id",
             "conversationalService.messageId": "message_id",
+            "conversationalService.endExchange": "end_exchange",
             "mcpServer.id": "mcp_server_id",
             "mcpServer.slug": "mcp_server_slug",
             "voice.mode": "voice_mode",

tests/test_chat.py

@@ -257,6 +257,70 @@ async def test_chat_runtime_stream_yields_all_events():
     assert cast(AsyncMock, bridge.emit_message_event).await_count == 2
 
 
+@pytest.mark.asyncio
+async def test_chat_runtime_emits_exchange_end_by_default():
+    """Without end_exchange specified, exchange end is emitted."""
+
+    runtime_impl = StreamingMockRuntime(messages=["Hello"])
+    bridge = make_chat_bridge_mock()
+
+    chat_runtime = UiPathChatRuntime(
+        delegate=runtime_impl,
+        chat_bridge=bridge,
+    )
+
+    result = await chat_runtime.execute({})
+
+    await chat_runtime.dispose()
+
+    assert result.status == UiPathRuntimeStatus.SUCCESSFUL
+    cast(AsyncMock, bridge.emit_exchange_end_event).assert_awaited_once()
+
+
+@pytest.mark.asyncio
+async def test_chat_runtime_emits_exchange_end_when_end_exchange_true():
+    """end_exchange=True emits the exchange end event."""
+
+    runtime_impl = StreamingMockRuntime(messages=["Hello"])
+    bridge = make_chat_bridge_mock()
+
+    chat_runtime = UiPathChatRuntime(
+        delegate=runtime_impl,
+        chat_bridge=bridge,
+        end_exchange=True,
+    )
+
+    result = await chat_runtime.execute({})
+
+    await chat_runtime.dispose()
+
+    assert result.status == UiPathRuntimeStatus.SUCCESSFUL
+    cast(AsyncMock, bridge.emit_exchange_end_event).assert_awaited_once()
+
+
+@pytest.mark.asyncio
+async def test_chat_runtime_skips_exchange_end_when_end_exchange_false():
+    """end_exchange=False suppresses the exchange end event but completes normally."""
+
+    runtime_impl = StreamingMockRuntime(messages=["Hello", "World"])
+    bridge = make_chat_bridge_mock()
+
+    chat_runtime = UiPathChatRuntime(
+        delegate=runtime_impl,
+        chat_bridge=bridge,
+        end_exchange=False,
+    )
+
+    result = await chat_runtime.execute({})
+
+    await chat_runtime.dispose()
+
+    # Execution completes normally; only the exchange end emission is skipped
+    assert result.status == UiPathRuntimeStatus.SUCCESSFUL
+    assert cast(AsyncMock, bridge.emit_message_event).await_count == 2
+    cast(AsyncMock, bridge.emit_exchange_end_event).assert_not_awaited()
+
+
 @pytest.mark.asyncio
 async def test_chat_runtime_handles_errors():
     """On unexpected errors, UiPathChatRuntime should propagate them."""

tests/test_context.py

@@ -241,6 +241,38 @@ def test_from_config_loads_runtime_and_fps_properties(tmp_path: Path) -> None:
     assert ctx.mcp_server_slug == "test-server-slug"
 
 
+def test_from_config_maps_end_exchange_fps_property(tmp_path: Path) -> None:
+    """conversationalService.endExchange should map onto end_exchange."""
+    cfg = {
+        "fpsProperties": {
+            "conversationalService.conversationId": "conv-123",
+            "conversationalService.exchangeId": "ex-456",
+            "conversationalService.endExchange": False,
+        }
+    }
+    config_path = tmp_path / "uipath.json"
+    config_path.write_text(json.dumps(cfg))
+
+    ctx = UiPathRuntimeContext.from_config(config_path=str(config_path))
+
+    assert ctx.end_exchange is False
+
+
+def test_end_exchange_defaults_true_when_fps_property_absent(tmp_path: Path) -> None:
+    """end_exchange defaults to True (legacy behavior) when the fps key is missing."""
+    cfg = {
+        "fpsProperties": {
+            "conversationalService.conversationId": "conv-123",
+        }
+    }
+    config_path = tmp_path / "uipath.json"
+    config_path.write_text(json.dumps(cfg))
+
+    ctx = UiPathRuntimeContext.from_config(config_path=str(config_path))
+
+    assert ctx.end_exchange is True
+
+
 def test_result_file_written_on_faulted_trigger_error(tmp_path: Path) -> None:
     runtime_dir = tmp_path / "runtime"
     ctx = UiPathRuntimeContext(