fix: move voice prompt from agents to python repo (#1463)

Author: JoshParkSJ

packages/uipath/pyproject.toml

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

@@ -7,6 +7,7 @@
     PromptUserSettings,
     get_chat_system_prompt,
 )
+from .conversational_voice_prompts import get_voice_system_prompt
 from .prompts import AGENT_SYSTEM_PROMPT_TEMPLATE
 from .tools import (
     END_EXECUTION_TOOL,
@@ -25,4 +26,5 @@
     "RaiseErrorToolSchemaModel",
     "PromptUserSettings",
     "get_chat_system_prompt",
+    "get_voice_system_prompt",
 ]

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

@@ -175,13 +175,13 @@ def get_chat_system_prompt(
     )
     prompt = prompt.replace(
         "{{CONVERSATIONAL_AGENT_SERVICE_PREFIX_userSettingsPrompt}}",
-        _get_user_settings_template(user_settings),
+        get_user_settings_template(user_settings),
     )
 
     return prompt
 
 
-def _get_user_settings_template(
+def get_user_settings_template(
     user_settings: PromptUserSettings | None,
 ) -> str:
     """Get the user settings template section.

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

@@ -0,0 +1,53 @@
+"""Conversational voice agent prompt generation logic."""
+
+from datetime import datetime, timezone
+
+from .conversational_prompts import PromptUserSettings, get_user_settings_template
+
+_VOICE_SYSTEM_PROMPT_TEMPLATE = """You are {{VOICE_AGENT_PREFIX_agentName}}.
+The current date is: {{VOICE_AGENT_PREFIX_currentDate}}.
+
+=====================================================================
+AGENT SYSTEM PROMPT
+=====================================================================
+{{VOICE_AGENT_PREFIX_systemPrompt}}
+
+{{VOICE_AGENT_PREFIX_userSettingsPrompt}}
+
+=====================================================================
+TOOL USAGE RULES
+=====================================================================
+Use the end call tool to end the call when:
+- The primary objective of the call has been fulfilled and the user confirms they have no further questions
+- The user explicitly asks to end the call or says goodbye
+
+"""
+
+
+def get_voice_system_prompt(
+    system_message: str,
+    agent_name: str | None,
+    user_settings: PromptUserSettings | None = None,
+) -> str:
+    """Build the full voice system prompt with agent name, date, and optional user context."""
+    formatted_date = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%MZ")
+
+    prompt = _VOICE_SYSTEM_PROMPT_TEMPLATE
+    prompt = prompt.replace(
+        "{{VOICE_AGENT_PREFIX_agentName}}",
+        agent_name or "Voice Assistant",
+    )
+    prompt = prompt.replace(
+        "{{VOICE_AGENT_PREFIX_currentDate}}",
+        formatted_date,
+    )
+    prompt = prompt.replace(
+        "{{VOICE_AGENT_PREFIX_systemPrompt}}",
+        system_message,
+    )
+    prompt = prompt.replace(
+        "{{VOICE_AGENT_PREFIX_userSettingsPrompt}}",
+        get_user_settings_template(user_settings),
+    )
+
+    return prompt

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

@@ -7,8 +7,8 @@
 
 from uipath.agent.react.conversational_prompts import (
     PromptUserSettings,
-    _get_user_settings_template,
     get_chat_system_prompt,
+    get_user_settings_template,
 )
 
 SYSTEM_MESSAGE = "You are a helpful assistant."
@@ -235,23 +235,23 @@ def test_default_none_values(self):
 
 
 class TestGetUserSettingsTemplate:
-    """Tests for _get_user_settings_template helper."""
+    """Tests for get_user_settings_template helper."""
 
     def test_none_returns_empty(self):
         """Returns empty string when user_settings is None."""
-        result = _get_user_settings_template(None)
+        result = get_user_settings_template(None)
         assert result == ""
 
     def test_empty_settings_returns_empty(self):
         """Returns empty string when all fields are None."""
         settings = PromptUserSettings()
-        result = _get_user_settings_template(settings)
+        result = get_user_settings_template(settings)
         assert result == ""
 
     def test_partial_settings_includes_non_none_only(self):
         """Only includes non-None fields in JSON."""
         settings = PromptUserSettings(name="Test", email="test@example.com")
-        result = _get_user_settings_template(settings)
+        result = get_user_settings_template(settings)
 
         assert "USER CONTEXT" in result
         assert '"name": "Test"' in result or '"name":"Test"' in result
@@ -271,7 +271,7 @@ def test_full_settings_json_format(self):
             country="UK",
             timezone="Europe/London",
         )
-        result = _get_user_settings_template(settings)
+        result = get_user_settings_template(settings)
 
         # Extract JSON from the result
         json_match = re.search(r"```json\s*(\{[^`]+\})\s*```", result)

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

@@ -0,0 +1,40 @@
+"""Tests for voice agent prompt generation."""
+
+from uipath.agent.react import PromptUserSettings, get_voice_system_prompt
+
+
+class TestGetVoiceSystemPrompt:
+    """Test get_voice_system_prompt with various user settings."""
+
+    def test_no_user_settings(self) -> None:
+        result = get_voice_system_prompt("Be helpful.", "Agent")
+        assert "USER CONTEXT" not in result
+        assert "Be helpful." in result
+
+    def test_with_user_settings(self) -> None:
+        settings = PromptUserSettings(name="Alice", email="alice@test.com")
+        result = get_voice_system_prompt("Be helpful.", "Agent", user_settings=settings)
+        assert "USER CONTEXT" in result
+        assert '"name": "Alice"' in result
+        assert '"email": "alice@test.com"' in result
+
+    def test_user_settings_none_values_excluded(self) -> None:
+        settings = PromptUserSettings(name="Bob")
+        result = get_voice_system_prompt("Be helpful.", "Agent", user_settings=settings)
+        assert '"name": "Bob"' in result
+        assert "email" not in result
+
+    def test_user_settings_all_none_skipped(self) -> None:
+        settings = PromptUserSettings()
+        result = get_voice_system_prompt("Be helpful.", "Agent", user_settings=settings)
+        assert "USER CONTEXT" not in result
+
+    def test_default_agent_name(self) -> None:
+        result = get_voice_system_prompt("Hello.", None)
+        assert "You are Voice Assistant." in result
+
+    def test_includes_date_and_system_message(self) -> None:
+        result = get_voice_system_prompt("Do things.", "MyAgent")
+        assert "You are MyAgent." in result
+        assert "The current date is:" in result
+        assert "Do things." in result