diff --git a/packages/uipath-platform/pyproject.toml b/packages/uipath-platform/pyproject.toml index 524b09334..aa351fc35 100644 --- a/packages/uipath-platform/pyproject.toml +++ b/packages/uipath-platform/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "uipath-platform" -version = "0.1.2" +version = "0.1.3" description = "HTTP client library for programmatic access to UiPath Platform" readme = { file = "README.md", content-type = "text/markdown" } requires-python = ">=3.11" diff --git a/packages/uipath-platform/src/uipath/platform/common/retry.py b/packages/uipath-platform/src/uipath/platform/common/retry.py index 762fe84ee..ff4b5a064 100644 --- a/packages/uipath-platform/src/uipath/platform/common/retry.py +++ b/packages/uipath-platform/src/uipath/platform/common/retry.py @@ -11,7 +11,7 @@ from ..errors import EnrichedException -RETRYABLE_STATUS_CODES: frozenset[int] = frozenset({408, 429, 502, 503, 504}) +RETRYABLE_STATUS_CODES: frozenset[int] = frozenset({408, 429, 502, 503, 504, 524}) NON_RETRYABLE_STATUS_CODES: frozenset[int] = frozenset({400, 401, 403, 404, 413, 422}) diff --git a/packages/uipath-platform/tests/services/test_retry.py b/packages/uipath-platform/tests/services/test_retry.py index ce27ef823..ab893f042 100644 --- a/packages/uipath-platform/tests/services/test_retry.py +++ b/packages/uipath-platform/tests/services/test_retry.py @@ -4,7 +4,6 @@ from uipath.platform.common.retry import ( _MAX_BACKOFF_DELAY, _MAX_RETRY_AFTER_DELAY, - RETRYABLE_STATUS_CODES, exponential_backoff_with_jitter, extract_retry_after_from_chain, is_retryable_platform_exception, @@ -15,26 +14,6 @@ from uipath.platform.errors import EnrichedException -class TestRetryableStatusCodes: - def test_contains_expected_codes(self): - assert 408 in RETRYABLE_STATUS_CODES - assert 429 in RETRYABLE_STATUS_CODES - assert 502 in RETRYABLE_STATUS_CODES - assert 503 in RETRYABLE_STATUS_CODES - assert 504 in RETRYABLE_STATUS_CODES - - def test_does_not_contain_non_retryable(self): - assert 400 not in RETRYABLE_STATUS_CODES - assert 401 not in RETRYABLE_STATUS_CODES - assert 403 not in RETRYABLE_STATUS_CODES - assert 404 not in RETRYABLE_STATUS_CODES - assert 500 not in RETRYABLE_STATUS_CODES - assert 501 not in RETRYABLE_STATUS_CODES - - def test_is_frozenset(self): - assert isinstance(RETRYABLE_STATUS_CODES, frozenset) - - class TestParseRetryAfter: def test_valid_integer(self): assert parse_retry_after("120") == 120.0 @@ -170,16 +149,36 @@ def test_timeout_exception(self): err = httpx.TimeoutException("timed out") assert is_retryable_platform_exception(err) is True + def test_enriched_408(self): + http_err = _make_http_status_error(408) + err = EnrichedException(http_err) + assert is_retryable_platform_exception(err) is True + def test_enriched_429(self): http_err = _make_http_status_error(429) err = EnrichedException(http_err) assert is_retryable_platform_exception(err) is True + def test_enriched_502(self): + http_err = _make_http_status_error(502) + err = EnrichedException(http_err) + assert is_retryable_platform_exception(err) is True + def test_enriched_503(self): http_err = _make_http_status_error(503) err = EnrichedException(http_err) assert is_retryable_platform_exception(err) is True + def test_enriched_504(self): + http_err = _make_http_status_error(504) + err = EnrichedException(http_err) + assert is_retryable_platform_exception(err) is True + + def test_enriched_524_cloudflare_timeout(self): + http_err = _make_http_status_error(524) + err = EnrichedException(http_err) + assert is_retryable_platform_exception(err) is True + def test_enriched_400_not_retryable(self): http_err = _make_http_status_error(400) err = EnrichedException(http_err) diff --git a/packages/uipath-platform/uv.lock b/packages/uipath-platform/uv.lock index 944afad38..d6e00b33c 100644 --- a/packages/uipath-platform/uv.lock +++ b/packages/uipath-platform/uv.lock @@ -1088,7 +1088,7 @@ dev = [ [[package]] name = "uipath-platform" -version = "0.1.2" +version = "0.1.3" source = { editable = "." } dependencies = [ { name = "httpx" }, diff --git a/packages/uipath/docs/core/assets/studio_web_diagram_dark.png b/packages/uipath/docs/core/assets/studio_web_diagram_dark.png new file mode 100644 index 000000000..aead8460f Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_diagram_dark.png differ diff --git a/packages/uipath/docs/core/assets/studio_web_diagram_light.png b/packages/uipath/docs/core/assets/studio_web_diagram_light.png new file mode 100644 index 000000000..6fa1c57f4 Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_diagram_light.png differ diff --git a/packages/uipath/docs/core/assets/studio_web_select_coded_dark.png b/packages/uipath/docs/core/assets/studio_web_select_coded_dark.png new file mode 100644 index 000000000..723a41a8d Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_select_coded_dark.png differ diff --git a/packages/uipath/docs/core/assets/studio_web_select_coded_light.png b/packages/uipath/docs/core/assets/studio_web_select_coded_light.png new file mode 100644 index 000000000..a50f01c0a Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_select_coded_light.png differ diff --git a/packages/uipath/docs/core/assets/studio_web_sync_from_ide_dark.png b/packages/uipath/docs/core/assets/studio_web_sync_from_ide_dark.png new file mode 100644 index 000000000..d47a72103 Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_sync_from_ide_dark.png differ diff --git a/packages/uipath/docs/core/assets/studio_web_sync_from_ide_light.png b/packages/uipath/docs/core/assets/studio_web_sync_from_ide_light.png new file mode 100644 index 000000000..8fafc7493 Binary files /dev/null and b/packages/uipath/docs/core/assets/studio_web_sync_from_ide_light.png differ diff --git a/packages/uipath/docs/core/studio_web.md b/packages/uipath/docs/core/studio_web.md new file mode 100644 index 000000000..762735e48 --- /dev/null +++ b/packages/uipath/docs/core/studio_web.md @@ -0,0 +1,244 @@ +# Studio Web Integration + +[Studio Web](https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/overview) is a cloud IDE for building projects such as RPAs, low code agents, and API workflows. It also supports importing coded agents built locally. Bringing your coded agent into Studio Web gives you: + +- Cloud debugging with dynamic breakpoints +- Running and defining evaluations directly in the cloud +- A unified build experience alongside multiple project types +- Self contained solution deployment units + + + + Coded agent in Studio Web + + +There are two ways to connect a coded agent to Studio Web: using a [Cloud Workspace](#cloud-workspace) or a [Local Workspace](#local-workspace). + +--- + +## Cloud Workspace + +In a Cloud Workspace, your project lives in Studio Web and you sync code between your local IDE and the cloud. + +### Importing a Coded Agent + +1. Open your solution in Studio Web +2. Create a new Agent and select **Coded** + + + + + + +3. Choose a sample project to start from, or push an existing local agent + +### Pushing an Existing Agent + +If you already have a coded agent locally, you can sync it to Studio Web: + +1. Copy the `UIPATH_PROJECT_ID` from Studio Web into your `.env` file + + + + + + +2. Push your project: + + + ```shell + > uipath push + Pushing UiPath project to Studio Web... + Uploading 'main.py' + Uploading 'uipath.json' + Updating 'pyproject.toml' + Uploading '.uipath/studio_metadata.json' + Importing referenced resources to Studio Web project... + 🔵 Resource import summary: 3 total resources - 1 created, 1 updated, 1 unchanged, 0 not found + ``` + + Notice the **Resource import summary** at the end. The push command also imports resources defined in `bindings.json` into the Studio Web solution, just like importing resources for a low code agent. This ensures that all required resources are packaged with the solution, so the coded agent works anywhere the solution is deployed. + + See [`uipath push`](../cli/index.md) in the CLI Reference. + +### Pulling Changes + +To pull the latest version from Studio Web to your local environment: + + +```shell +> uipath pull +Pulling UiPath project from Studio Web... +Processing: main.py +File 'main.py' is up to date +Processing: uipath.json +File 'uipath.json' is up to date +Processing: bindings.json +File 'bindings.json' is up to date +Processing: evaluations\eval-sets\evaluation-set-default.json +Downloaded 'evaluations\eval-sets\evaluation-set-default.json' +Processing: evaluations\evaluators\evaluator-default.json +Downloaded 'evaluations\evaluators\evaluator-default.json' +✓ Project pulled successfully +``` + +See [`uipath pull`](../cli/index.md) in the CLI Reference. + +--- + +## Local Workspace + +!!! warning "Preview Feature" + The local workspace integration is currently experimental. + Behavior is subject to change in future versions. + +In a Local Workspace, your project lives on your machine and is linked to a Studio Web solution. See the [Local Workspace documentation](https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/solutions-in-the-local-workspace) for setup details. + +You can either start from a predefined template in Studio Web or set up a new agent from scratch. + +### Starting from a Template + +When creating a new Coded agent in Studio Web with a Local Workspace, you can pick one of the predefined templates. This creates the project files directly on your machine. Templates come with sample code and predefined evaluations you can run immediately. + +### Setting Up a New Agent + +You can also create a coded agent from scratch in your local IDE and have it appear in Studio Web. + +First, install the SDK package for the framework you want to use: + +//// tab | uv + + +```shell +# Pick the package that matches your framework: +# uipath-langchain - LangChain / LangGraph +# uipath-openai-agents - OpenAI Agents SDK +# uipath-llamaindex - LlamaIndex +# uipath-pydantic-ai - PydanticAI +# uipath-google-adk - Google ADK +# uipath-agent-framework - UiPath Agent Framework +> uv add uipath-langchain +Resolved 42 packages in 1.2s +Installed 42 packages in 0.8s +``` + +//// + +//// tab | pip + + +```shell +# Pick the package that matches your framework: +# uipath-langchain - LangChain / LangGraph +# uipath-openai-agents - OpenAI Agents SDK +# uipath-llamaindex - LlamaIndex +# uipath-pydantic-ai - PydanticAI +# uipath-google-adk - Google ADK +# uipath-agent-framework - UiPath Agent Framework +> pip install uipath-langchain +Successfully installed uipath-langchain +``` + +//// + +Then authenticate, scaffold the agent, and initialize the project: + + +```shell +> uipath auth +⠋ Authenticating with UiPath ... +🔗 If a browser window did not open, please open the following URL in your browser: [LINK] +👇 Select tenant: + 0: Tenant1 + 1: Tenant2 +Select tenant number: 0 +Selected tenant: Tenant1 +✓ Authentication successful. + +> uipath new agent +✓ Created new agent project. + +> uipath init +⠋ Initializing UiPath project ... +✓ Created 'entry-points.json' file. +``` + +That's it, your agent should now be visible in Studio Web. + +--- + +## Publishing + +Once your coded agent is in Studio Web, publishing works the same as any other project. Click **Publish** in Studio Web and it will be packaged and deployed through the standard workflow. + +--- + +## Running and Debugging + +Your agent can be run both in the cloud (via Studio Web) and locally using the CLI. + +### Running Locally + + +```shell +> uipath run agent '{"message": "hello"}' +``` + +See [`uipath run`](../cli/index.md) in the CLI Reference. + +### Debugging Locally + +Use `uipath debug` for an enhanced local debugging experience. Unlike `uipath run`, the debug command: + +- Auto polls for trigger responses when the agent suspends (e.g., LangGraph interrupts) +- Fetches binding overwrites from Studio Web (configurable in **Debug > Debug Configuration > Solution resources**) + + +```shell +> uipath debug agent '{"message": "hello"}' +``` + +See [`uipath debug`](../cli/index.md) in the CLI Reference. + +### Evaluating Locally + +Run evaluations against your agent using the CLI: + + +```shell +> uipath eval agent .\evaluations\eval-sets\faithfulness-multi-model.json +``` + +See [`uipath eval`](../cli/index.md) in the CLI Reference and the [Evaluations documentation](../eval/index.md). + +--- + +## Syncing Evaluations + +Evaluations can be defined either in Studio Web or locally. They sync automatically when you use `uipath pull` and `uipath push`. + +/// note +Custom evaluators must be created locally. See [Custom Evaluators](../eval/custom_evaluators.md) for details. +/// diff --git a/packages/uipath/mkdocs.yml b/packages/uipath/mkdocs.yml index ea36fccc0..0b7fafd34 100644 --- a/packages/uipath/mkdocs.yml +++ b/packages/uipath/mkdocs.yml @@ -60,6 +60,7 @@ nav: - Environment Variables: core/environment_variables.md - CLI Reference: cli/index.md - Tracing: core/traced.md + - Studio Web Integration: core/studio_web.md - Services: - Assets: core/assets.md - Attachments: core/attachments.md diff --git a/packages/uipath/pyproject.toml b/packages/uipath/pyproject.toml index daef3366c..969495afe 100644 --- a/packages/uipath/pyproject.toml +++ b/packages/uipath/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "uipath" -version = "2.10.23" +version = "2.10.25" 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" diff --git a/packages/uipath/src/uipath/_cli/_utils/_common.py b/packages/uipath/src/uipath/_cli/_utils/_common.py index d5e9b2b8f..784192ab6 100644 --- a/packages/uipath/src/uipath/_cli/_utils/_common.py +++ b/packages/uipath/src/uipath/_cli/_utils/_common.py @@ -173,11 +173,14 @@ async def may_override_files( local_version_display = local_code_version if local_code_version else "Not Set" - try: - push_date = datetime.fromisoformat(remote_metadata.last_push_date) - formatted_date = push_date.strftime("%b %d, %Y at %I:%M %p UTC") - except (ValueError, TypeError): - formatted_date = remote_metadata.last_push_date + if not remote_metadata.last_push_date: + formatted_date = "unknown" + else: + try: + push_date = datetime.fromisoformat(remote_metadata.last_push_date) + formatted_date = push_date.strftime("%b %d, %Y at %I:%M %p UTC") + except (ValueError, TypeError): + formatted_date = remote_metadata.last_push_date console = ConsoleLogger() console.warning("Your local version is behind the remote version.") diff --git a/packages/uipath/src/uipath/_cli/_utils/_studio_project.py b/packages/uipath/src/uipath/_cli/_utils/_studio_project.py index 626a5fb06..bc3501d11 100644 --- a/packages/uipath/src/uipath/_cli/_utils/_studio_project.py +++ b/packages/uipath/src/uipath/_cli/_utils/_studio_project.py @@ -476,8 +476,8 @@ class StudioProjectMetadata(BaseModel): ) schema_version: int = Field(alias="schemaVersion") - last_push_date: str = Field(alias="lastPushDate") - last_push_author: str = Field(alias="lastPushAuthor") + last_push_date: str | None = Field(alias="lastPushDate", default=None) + last_push_author: str | None = Field(alias="lastPushAuthor", default=None) code_version: str = Field(alias="codeVersion") diff --git a/packages/uipath/src/uipath/agent/react/__init__.py b/packages/uipath/src/uipath/agent/react/__init__.py index e37b5c725..835fd0bda 100644 --- a/packages/uipath/src/uipath/agent/react/__init__.py +++ b/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", ] diff --git a/packages/uipath/src/uipath/agent/react/conversational_prompts.py b/packages/uipath/src/uipath/agent/react/conversational_prompts.py index 708aa0b3d..7732c7f69 100644 --- a/packages/uipath/src/uipath/agent/react/conversational_prompts.py +++ b/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. diff --git a/packages/uipath/src/uipath/agent/react/conversational_voice_prompts.py b/packages/uipath/src/uipath/agent/react/conversational_voice_prompts.py new file mode 100644 index 000000000..3e6036b12 --- /dev/null +++ b/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 diff --git a/packages/uipath/tests/agent/react/test_conversational_prompts.py b/packages/uipath/tests/agent/react/test_conversational_prompts.py index 1aa5585a2..a58a94807 100644 --- a/packages/uipath/tests/agent/react/test_conversational_prompts.py +++ b/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) diff --git a/packages/uipath/tests/agent/react/test_conversational_voice_prompts.py b/packages/uipath/tests/agent/react/test_conversational_voice_prompts.py new file mode 100644 index 000000000..ece66ea92 --- /dev/null +++ b/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 diff --git a/packages/uipath/uv.lock b/packages/uipath/uv.lock index e12c060bc..dc73b8526 100644 --- a/packages/uipath/uv.lock +++ b/packages/uipath/uv.lock @@ -2540,7 +2540,7 @@ wheels = [ [[package]] name = "uipath" -version = "2.10.23" +version = "2.10.25" source = { editable = "." } dependencies = [ { name = "applicationinsights" }, @@ -2679,7 +2679,7 @@ dev = [ [[package]] name = "uipath-platform" -version = "0.1.2" +version = "0.1.3" source = { editable = "../uipath-platform" } dependencies = [ { name = "httpx" },