feat: add set_conversational_output tool + generate-output prompt for conversational agents (#1785)

Author: maxduu

packages/uipath/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.13.5"
+version = "2.13.6"
 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"

packages/uipath/src/uipath/agent/react/__init__.py

@@ -6,25 +6,31 @@
 from .conversational_prompts import (
     PromptUserSettings,
     get_chat_system_prompt,
+    get_generate_output_prompt,
 )
 from .conversational_voice_prompts import get_voice_system_prompt
 from .prompts import AGENT_SYSTEM_PROMPT_TEMPLATE
 from .tools import (
     END_EXECUTION_TOOL,
     RAISE_ERROR_TOOL,
+    SET_CONVERSATIONAL_OUTPUT_TOOL,
     EndExecutionToolSchemaModel,
     FlowControlToolConfig,
     RaiseErrorToolSchemaModel,
+    SetConversationalOutputToolSchemaModel,
 )
 
 __all__ = [
     "AGENT_SYSTEM_PROMPT_TEMPLATE",
     "FlowControlToolConfig",
     "END_EXECUTION_TOOL",
     "RAISE_ERROR_TOOL",
+    "SET_CONVERSATIONAL_OUTPUT_TOOL",
     "EndExecutionToolSchemaModel",
     "RaiseErrorToolSchemaModel",
+    "SetConversationalOutputToolSchemaModel",
     "PromptUserSettings",
     "get_chat_system_prompt",
+    "get_generate_output_prompt",
     "get_voice_system_prompt",
 ]

packages/uipath/src/uipath/agent/react/conversational_prompts.py

@@ -233,3 +233,21 @@ def get_conversation_id_template(conversation_id: str | None) -> str:
     if not conversation_id:
         return ""
     return _CONVERSATION_ID_TEMPLATE.format(conversation_id=conversation_id)
+
+
+_GENERATE_OUTPUT_INSTRUCTION = """The conversational response for this turn has already been delivered to the user. Call the `set_conversational_output` tool to record the structured output fields for this turn.
+
+Rules:
+- For each field, use values inferred from the conversation's recent turn.
+- For optional fields that are not yet relevant or determinable (e.g. the conversation is still gathering context, or the topic hasn't surfaced yet), omit them entirely.
+- For required fields that cannot yet be determined, provide a default placeholder. DO NOT fabricate, guess, or hallucinate meaningful values.
+- Do not produce any text response, as this will not be seen by the user. Only call the tool."""
+
+
+def get_generate_output_prompt() -> str:
+    """Return the framework-internal generate-output instruction.
+
+    Appended as a final user-message to the conversational structured-output
+    node's LLM call.
+    """
+    return _GENERATE_OUTPUT_INSTRUCTION

packages/uipath/src/uipath/agent/react/tools.py

@@ -11,6 +11,7 @@ class FlowControlToolName(str, Enum):
 
     END_EXECUTION = "end_execution"
     RAISE_ERROR = "raise_error"
+    SET_CONVERSATIONAL_OUTPUT = "set_conversational_output"
 
 
 @dataclass(frozen=True)
@@ -72,3 +73,25 @@ class RaiseErrorToolSchemaModel(BaseModel):
     description="Raises an error and ends the execution of the agent",
     args_schema=RaiseErrorToolSchemaModel,
 )
+
+
+class SetConversationalOutputToolSchemaModel(BaseModel):
+    """Placeholder args_schema for the `set_conversational_output` tool.
+
+    Always overridden at construction time with the agent's stripped output
+    schema (i.e. the user's `outputSchema` with `uipath__agent_response_messages`
+    removed). Declared here so the tool entry has a well-typed default.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+
+SET_CONVERSATIONAL_OUTPUT_TOOL = FlowControlToolConfig(
+    name=FlowControlToolName.SET_CONVERSATIONAL_OUTPUT,
+    description=(
+        "Sets the structured output fields for the current conversational "
+        "turn. Called once per turn after the conversational response has been "
+        "delivered, to populate fields as the agent's output."
+    ),
+    args_schema=SetConversationalOutputToolSchemaModel,
+)

packages/uipath/tests/agent/react/test_conversational_prompts.py

@@ -8,6 +8,7 @@
 from uipath.agent.react.conversational_prompts import (
     PromptUserSettings,
     get_chat_system_prompt,
+    get_generate_output_prompt,
     get_user_settings_template,
 )
 
@@ -348,3 +349,16 @@ def test_full_settings_json_format(self):
         assert json_data["company"] == "Big Corp"
         assert json_data["country"] == "UK"
         assert json_data["timezone"] == "Europe/London"
+
+
+class TestGetGenerateOutputPrompt:
+    """Tests for get_generate_output_prompt function."""
+
+    def test_returns_non_empty_string(self):
+        instruction = get_generate_output_prompt()
+        assert isinstance(instruction, str)
+        assert instruction.strip()
+
+    def test_references_set_conversational_output_tool(self):
+        """The instruction must name the tool the new node binds."""
+        assert "set_conversational_output" in get_generate_output_prompt()