uipath 2.1.84__tar.gz → 2.1.86__tar.gz

uipath-2.1.86/.github/workflows/test-uipath-langchain.yml

@@ -0,0 +1,144 @@
+name: Test UiPath Langchain
+
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened, labeled ]
+
+jobs:
+  test-uipath-langchain:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
+        os: [ ubuntu-latest, windows-latest ]
+
+    permissions:
+      contents: read
+
+    # Only run if PR has the test:uipath-langchain label
+    if: contains(github.event.pull_request.labels.*.name, 'test:uipath-langchain')
+
+    steps:
+      - name: Checkout uipath-python
+        uses: actions/checkout@v4
+        with:
+          path: 'uipath-python'
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build uipath-python package
+        working-directory: uipath-python
+        run: uv build
+
+      - name: Checkout uipath-langchain-python
+        uses: actions/checkout@v4
+        with:
+          repository: 'UiPath/uipath-langchain-python'
+          path: 'uipath-langchain-python'
+
+      - name: Update uipath-python version
+        shell: bash
+        working-directory: uipath-langchain-python
+        run: uv add ../uipath-python/dist/*.whl --dev
+
+      - name: Run uipath-langchain tests
+        working-directory: uipath-langchain-python
+        run: |
+          uv sync
+          uv run pytest
+
+  discover-testcases:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    needs: [test-uipath-langchain]
+    outputs:
+      testcases: ${{ steps.discover.outputs.testcases }}
+    steps:
+      - name: Checkout uipath-langchain-python
+        uses: actions/checkout@v4
+        with:
+          repository: 'UiPath/uipath-langchain-python'
+          path: 'uipath-langchain-python'
+
+      - name: Discover testcases
+        id: discover
+        working-directory: uipath-langchain-python
+        run: |
+          # Find all testcase folders (excluding common folders like README, etc.)
+          testcase_dirs=$(find testcases -maxdepth 1 -type d -name "*-*" | sed 's|testcases/||' | sort)
+
+          echo "Found testcase directories:"
+          echo "$testcase_dirs"
+
+          # Convert to JSON array for matrix
+          testcases_json=$(echo "$testcase_dirs" | jq -R -s -c 'split("\n")[:-1]')
+          echo "testcases=$testcases_json" >> $GITHUB_OUTPUT
+
+  run-uipath-langchain-integration-tests:
+    runs-on: ubuntu-latest
+    needs: [discover-testcases]
+    container:
+      image: ghcr.io/astral-sh/uv:python3.12-bookworm
+      env:
+        UIPATH_JOB_KEY: "3a03d5cb-fa21-4021-894d-a8e2eda0afe0"
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        testcase: ${{ fromJson(needs.discover-testcases.outputs.testcases) }}
+        environment: [alpha, staging] # temporary disable [cloud]
+        use_azure_chat: [true, false]
+
+    name: "${{ matrix.testcase }} / ${{ matrix.environment }} / ${{ matrix.use_azure_chat && 'UiPathAzureChatOpenAI' || 'UiPathChat' }}"
+
+    steps:
+      - name: Checkout uipath-python
+        uses: actions/checkout@v4
+        with:
+          path: 'uipath-python'
+
+      - name: Build uipath-python package
+        working-directory: uipath-python
+        run: uv build
+
+      - name: Checkout uipath-langchain-python
+        uses: actions/checkout@v4
+        with:
+          repository: 'UiPath/uipath-langchain-python'
+          path: 'uipath-langchain-python'
+
+      - name: Update uipath-python version
+        shell: bash
+        working-directory: uipath-langchain-python
+        run: uv add ../uipath-python/dist/*.whl
+
+      - name: Install dependencies
+        working-directory: uipath-langchain-python
+        run: uv sync
+
+      - name: Run testcase
+        env:
+          CLIENT_ID:      ${{ matrix.environment == 'alpha' && secrets.ALPHA_TEST_CLIENT_ID || matrix.environment == 'staging' && secrets.STAGING_TEST_CLIENT_ID || matrix.environment == 'cloud' && secrets.CLOUD_TEST_CLIENT_ID }}
+          CLIENT_SECRET:  ${{ matrix.environment == 'alpha' && secrets.ALPHA_TEST_CLIENT_SECRET || matrix.environment == 'staging' && secrets.STAGING_TEST_CLIENT_SECRET || matrix.environment == 'cloud' && secrets.CLOUD_TEST_CLIENT_SECRET }}
+          BASE_URL:       ${{ matrix.environment == 'alpha' && secrets.ALPHA_BASE_URL || matrix.environment == 'staging' && secrets.STAGING_BASE_URL || matrix.environment == 'cloud' && secrets.CLOUD_BASE_URL }}
+          USE_AZURE_CHAT: ${{ matrix.use_azure_chat }}
+          UV_PYTHON: "3.12"
+        working-directory: uipath-langchain-python/testcases/${{ matrix.testcase }}
+        run: |
+          echo "Running testcase: ${{ matrix.testcase }}"
+          echo "Environment: ${{ matrix.environment }}"
+          echo "LLM: ${{ matrix.use_azure_chat && 'UiPathAzureChatOpenAI' || 'UiPathChat' }}"
+          echo "USE_AZURE_CHAT: ${{ matrix.use_azure_chat }}"
+
+          # Execute the testcase run script directly
+          bash run.sh
+          bash ../common/validate_output.sh
+

{uipath-2.1.84 → uipath-2.1.86}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.84
+Version: 2.1.86
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.1.84 → uipath-2.1.86}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.84"
+version = "2.1.86"
 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.10"

{uipath-2.1.84 → uipath-2.1.86}/src/uipath/_cli/_evals/_runtime.py

@@ -432,12 +432,12 @@ class UiPathEvalRuntime(UiPathBaseRuntime, Generic[T, C]):
     async def execute_runtime(
         self, eval_item: EvaluationItem
     ) -> UiPathEvalRunExecutionOutput:
-        eval_item_id = eval_item.id
+        execution_id = str(uuid.uuid4())
         runtime_context: C = self.factory.new_context(
-            execution_id=eval_item_id,
+            execution_id=execution_id,
             input_json=eval_item.inputs,
             is_eval_run=True,
-            log_handler=self._setup_execution_logging(eval_item_id),
+            log_handler=self._setup_execution_logging(execution_id),
         )
         if runtime_context.execution_id is None:
             raise ValueError("execution_id must be set for eval runs")
@@ -445,9 +445,8 @@ class UiPathEvalRuntime(UiPathBaseRuntime, Generic[T, C]):
         attributes = {
             "evalId": eval_item.id,
             "span_type": "eval",
+            "execution.id": runtime_context.execution_id,
         }
-        if runtime_context.execution_id:
-            attributes["execution.id"] = runtime_context.execution_id
 
         start_time = time()
         try:

{uipath-2.1.84 → uipath-2.1.86}/src/uipath/_cli/_utils/_project_files.py

@@ -1,13 +1,22 @@
 # type: ignore
+import hashlib
 import json
 import os
 import re
+from pathlib import Path
 from typing import Any, Dict, Optional, Tuple
 
+import click
 from pydantic import BaseModel
 
 from .._utils._console import ConsoleLogger
 from ._constants import is_binary_file
+from ._studio_project import (
+    ProjectFile,
+    ProjectFolder,
+    StudioClient,
+    get_folder_by_name,
+)
 
 try:
     import tomllib
@@ -431,3 +440,116 @@ def files_to_include(
                     )
                 )
     return extra_files
+
+
+def compute_normalized_hash(content: str) -> str:
+    """Compute hash of normalized content.
+
+    Args:
+        content: Content to hash
+
+    Returns:
+        str: SHA256 hash of the normalized content
+    """
+    try:
+        # Try to parse as JSON to handle formatting
+        json_content = json.loads(content)
+        normalized = json.dumps(json_content, indent=2)
+    except json.JSONDecodeError:
+        # Not JSON, normalize line endings
+        normalized = content.replace("\r\n", "\n").replace("\r", "\n")
+
+    return hashlib.sha256(normalized.encode("utf-8")).hexdigest()
+
+
+def collect_files_from_folder(
+    folder: ProjectFolder, base_path: str, files_dict: Dict[str, ProjectFile]
+) -> None:
+    """Recursively collect all files from a folder and its subfolders.
+
+    Args:
+        folder: The folder to collect files from
+        base_path: Base path for file paths
+        files_dict: Dictionary to store collected files
+    """
+    # Add files from current folder
+    for file in folder.files:
+        file_path = os.path.join(base_path, file.name)
+        files_dict[file_path] = file
+
+    # Recursively process subfolders
+    for subfolder in folder.folders:
+        subfolder_path = os.path.join(base_path, subfolder.name)
+        collect_files_from_folder(subfolder, subfolder_path, files_dict)
+
+
+async def download_folder_files(
+    studio_client: StudioClient,
+    folder: ProjectFolder,
+    base_path: Path,
+) -> None:
+    """Download files from a folder recursively.
+
+    Args:
+        studio_client: Studio client
+        folder: The folder to download files from
+        base_path: Base path for local file storage
+    """
+    files_dict: Dict[str, ProjectFile] = {}
+    collect_files_from_folder(folder, "", files_dict)
+    for file_path, remote_file in files_dict.items():
+        local_path = base_path / file_path
+        local_path.parent.mkdir(parents=True, exist_ok=True)
+
+        # Download remote file
+        response = await studio_client.download_file_async(remote_file.id)
+        remote_content = response.read().decode("utf-8")
+        remote_hash = compute_normalized_hash(remote_content)
+
+        if os.path.exists(local_path):
+            # Read and hash local file
+            with open(local_path, "r", encoding="utf-8") as f:
+                local_content = f.read()
+                local_hash = compute_normalized_hash(local_content)
+
+            # Compare hashes
+            if local_hash != remote_hash:
+                styled_path = click.style(str(file_path), fg="cyan")
+                console.warning(f"File {styled_path}" + " differs from remote version.")
+                response = click.prompt("Do you want to overwrite it? (y/n)", type=str)
+                if response.lower() == "y":
+                    with open(local_path, "w", encoding="utf-8", newline="\n") as f:
+                        f.write(remote_content)
+                    console.success(f"Updated {click.style(str(file_path), fg='cyan')}")
+                else:
+                    console.info(f"Skipped {click.style(str(file_path), fg='cyan')}")
+            else:
+                console.info(
+                    f"File {click.style(str(file_path), fg='cyan')} is up to date"
+                )
+        else:
+            # File doesn't exist locally, create it
+            with open(local_path, "w", encoding="utf-8", newline="\n") as f:
+                f.write(remote_content)
+            console.success(f"Downloaded {click.style(str(file_path), fg='cyan')}")
+
+
+async def pull_project(project_id: str, download_configuration: dict[str, Path]):
+    studio_client = StudioClient(project_id)
+
+    with console.spinner("Pulling UiPath project files..."):
+        try:
+            structure = await studio_client.get_project_structure_async()
+            for source_key, destination in download_configuration.items():
+                source_folder = get_folder_by_name(structure, source_key)
+                if source_folder:
+                    await download_folder_files(
+                        studio_client,
+                        source_folder,
+                        destination,
+                    )
+                else:
+                    console.warning(f"No {source_key} folder found in remote project")
+
+        except Exception as e:
+            console.error(f"Failed to pull UiPath project: {str(e)}")

uipath-2.1.86/src/uipath/_cli/cli_pull.py

@@ -0,0 +1,59 @@
+# type: ignore
+"""CLI command for pulling remote project files from UiPath StudioWeb solution.
+
+This module provides functionality to pull remote project files from a UiPath StudioWeb solution.
+It handles:
+- File downloads from source_code and evals folders
+- Maintaining folder structure locally
+- File comparison using hashes
+- Interactive confirmation for overwriting files
+"""
+
+# type: ignore
+import asyncio
+import os
+from pathlib import Path
+
+import click
+
+from ..telemetry import track
+from ._utils._console import ConsoleLogger
+from ._utils._constants import UIPATH_PROJECT_ID
+from ._utils._project_files import pull_project
+
+console = ConsoleLogger()
+
+
+@click.command()
+@click.argument(
+    "root",
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, path_type=Path),
+    default=Path("."),
+)
+@track
+def pull(root: Path) -> None:
+    """Pull remote project files from Studio Web Project.
+
+    This command pulls the remote project files from a UiPath Studio Web project.
+    It downloads files from the source_code and evals folders, maintaining the
+    folder structure locally. Files are compared using hashes before overwriting,
+    and user confirmation is required for differing files.
+
+    Args:
+        root: The root directory to pull files into
+
+    Environment Variables:
+        UIPATH_PROJECT_ID: Required. The ID of the UiPath Studio Web project
+
+    Example:
+        $ uipath pull
+        $ uipath pull /path/to/project
+    """
+    if not (project_id := os.getenv(UIPATH_PROJECT_ID, False)):
+        console.error("UIPATH_PROJECT_ID environment variable not found.")
+
+    default_download_configuration = {
+        "source_code": root,
+        "evals": root / "evals",
+    }
+    asyncio.run(pull_project(project_id, default_download_configuration))

{uipath-2.1.84 → uipath-2.1.86}/src/uipath/_services/connections_service.py

@@ -7,7 +7,7 @@ from httpx import Response
 from .._config import Config
 from .._execution_context import ExecutionContext
 from .._utils import Endpoint, RequestSpec, header_folder, infer_bindings
-from ..models import Connection, ConnectionToken, EventArguments
+from ..models import Connection, ConnectionMetadata, ConnectionToken, EventArguments
 from ..models.connections import ConnectionTokenType
 from ..tracing._traced import traced
 from ._base_service import BaseService
@@ -54,6 +54,31 @@ class ConnectionsService(BaseService):
         response = self.request(spec.method, url=spec.endpoint)
         return Connection.model_validate(response.json())
 
+    @traced(
+        name="connections_metadata",
+        run_type="uipath",
+        hide_output=True,
+    )
+    def metadata(
+        self, element_instance_id: int, tool_path: str, schema_mode: bool = True
+    ) -> ConnectionMetadata:
+        """Synchronously retrieve connection API metadata.
+
+        This method fetches the metadata for a connection,
+        which can be used to establish communication with an external service.
+
+        Args:
+            element_instance_id (int): The element instance ID of the connection.
+            tool_path (str): The tool path to retrieve metadata for.
+            schema_mode (bool): Whether or not to represent the output schema in the response fields.
+
+        Returns:
+            ConnectionMetadata: The connection metadata.
+        """
+        spec = self._metadata_spec(element_instance_id, tool_path, schema_mode)
+        response = self.request(spec.method, url=spec.endpoint, headers=spec.headers)
+        return ConnectionMetadata.model_validate(response.json())
+
     @traced(name="connections_list", run_type="uipath")
     def list(
         self,
@@ -186,6 +211,33 @@ class ConnectionsService(BaseService):
         response = await self.request_async(spec.method, url=spec.endpoint)
         return Connection.model_validate(response.json())
 
+    @traced(
+        name="connections_metadata",
+        run_type="uipath",
+        hide_output=True,
+    )
+    async def metadata_async(
+        self, element_instance_id: int, tool_path: str, schema_mode: bool = True
+    ) -> ConnectionMetadata:
+        """Asynchronously retrieve connection API metadata.
+
+        This method fetches the metadata for a connection,
+        which can be used to establish communication with an external service.
+
+        Args:
+            element_instance_id (int): The element instance ID of the connection.
+            tool_path (str): The tool path to retrieve metadata for.
+            schema_mode (bool): Whether or not to represent the output schema in the response fields.
+
+        Returns:
+            ConnectionMetadata: The connection metadata.
+        """
+        spec = self._metadata_spec(element_instance_id, tool_path, schema_mode)
+        response = await self.request_async(
+            spec.method, url=spec.endpoint, headers=spec.headers
+        )
+        return ConnectionMetadata.model_validate(response.json())
+
     @traced(
         name="connections_retrieve_token",
         run_type="uipath",
@@ -324,6 +376,20 @@ class ConnectionsService(BaseService):
             endpoint=Endpoint(f"/connections_/api/v1/Connections/{key}"),
         )
 
+    def _metadata_spec(
+        self, element_instance_id: int, tool_path: str, schema_mode: bool
+    ) -> RequestSpec:
+        metadata_endpoint_url = f"/elements_/v3/element/instances/{element_instance_id}/elements/{tool_path}/metadata"
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(metadata_endpoint_url),
+            headers={
+                "accept": "application/schema+json"
+                if schema_mode
+                else "application/json"
+            },
+        )
+
     def _retrieve_token_spec(
         self, key: str, token_type: ConnectionTokenType = ConnectionTokenType.DIRECT
     ) -> RequestSpec:

{uipath-2.1.84 → uipath-2.1.86}/src/uipath/models/__init__.py

@@ -3,7 +3,7 @@ from .actions import Action
 from .assets import Asset, UserAsset
 from .attachment import Attachment
 from .buckets import Bucket
-from .connections import Connection, ConnectionToken, EventArguments
+from .connections import Connection, ConnectionMetadata, ConnectionToken, EventArguments
 from .context_grounding import ContextGroundingQueryResponse
 from .context_grounding_index import ContextGroundingIndex
 from .errors import BaseUrlMissingError, SecretMissingError
@@ -38,6 +38,7 @@ __all__ = [
     "QueueItemPriority",
     "TransactionItemResult",
     "Connection",
+    "ConnectionMetadata",
     "ConnectionToken",
     "EventArguments",
     "Job",

{uipath-2.1.84 → uipath-2.1.86}/src/uipath/models/connections.py

@@ -4,6 +4,14 @@ from typing import Any, Optional
 from pydantic import BaseModel, ConfigDict, Field
 
 
+class ConnectionMetadata(BaseModel):
+    """Metadata about a connection."""
+
+    fields: dict[str, Any] = Field(default_factory=dict, alias="fields")
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+
 class Connection(BaseModel):
     model_config = ConfigDict(
         validate_by_name=True,

uipath-2.1.86/src/uipath/utils/dynamic_schema.py

@@ -0,0 +1,111 @@
+"""Json schema to dynamic pydantic model."""
+
+from typing import Any, Dict, List, Optional, Type, Union
+
+from pydantic import BaseModel, Field, create_model
+
+
+def jsonschema_to_pydantic(
+    schema: dict[str, Any],
+    definitions: Optional[dict[str, Any]] = None,
+) -> Type[BaseModel]:
+    """Convert a schema dict to a pydantic model.
+
+    Modified version of https://github.com/kreneskyp/jsonschema-pydantic to account for two unresolved issues.
+
+    Args:
+        schema: JSON schema.
+        definitions: Definitions dict. Defaults to `$def`.
+
+    Returns: Pydantic model.
+    """
+    title = schema.get("title", "DynamicModel")
+    assert isinstance(title, str), "Title of a model must be a string."
+
+    description = schema.get("description", None)
+
+    # top level schema provides definitions
+    if definitions is None:
+        if "$defs" in schema:
+            definitions = schema["$defs"]
+        elif "definitions" in schema:
+            definitions = schema["definitions"]
+        else:
+            definitions = {}
+
+    def convert_type(prop: dict[str, Any]) -> Any:
+        if "$ref" in prop:
+            ref_path = prop["$ref"].split("/")
+            ref = definitions[ref_path[-1]]
+            return jsonschema_to_pydantic(ref, definitions)
+
+        if "type" in prop:
+            type_mapping = {
+                "string": str,
+                "number": float,
+                "integer": int,
+                "boolean": bool,
+                "array": List,
+                "object": Dict[str, Any],
+                "null": None,
+            }
+
+            type_ = prop["type"]
+
+            if type_ == "array":
+                item_type: Any = convert_type(prop.get("items", {}))
+                assert isinstance(item_type, type)
+                return List[item_type]  # noqa F821
+            elif type_ == "object":
+                if "properties" in prop:
+                    return jsonschema_to_pydantic(prop, definitions)
+                else:
+                    return Dict[str, Any]
+            else:
+                return type_mapping.get(type_, Any)
+
+        elif "allOf" in prop:
+            combined_fields = {}
+            for sub_schema in prop["allOf"]:
+                model = jsonschema_to_pydantic(sub_schema, definitions)
+                combined_fields.update(model.__annotations__)
+            return create_model("CombinedModel", **combined_fields)
+
+        elif "anyOf" in prop:
+            unioned_types = tuple(
+                convert_type(sub_schema) for sub_schema in prop["anyOf"]
+            )
+            return Union[unioned_types]
+        elif prop == {} or "type" not in prop:
+            return Any
+        else:
+            raise ValueError(f"Unsupported schema: {prop}")
+
+    fields: dict[str, Any] = {}
+    required_fields = schema.get("required", [])
+
+    for name, prop in schema.get("properties", {}).items():
+        pydantic_type = convert_type(prop)
+        field_kwargs = {}
+        if "default" in prop:
+            field_kwargs["default"] = prop["default"]
+        if name not in required_fields:
+            # Note that we do not make this optional. This is due to a limitation in Pydantic/Python.
+            # If we convert the Optional type back to json schema, it is represented as type | None.
+            # pydantic_type = Optional[pydantic_type]
+
+            if "default" not in field_kwargs:
+                field_kwargs["default"] = None
+        if "description" in prop:
+            field_kwargs["description"] = prop["description"]
+        if "title" in prop:
+            field_kwargs["title"] = prop["title"]
+
+        fields[name] = (pydantic_type, Field(**field_kwargs))
+
+    convert_type(schema.get("properties", {}).get("choices", {}))
+
+    model = create_model(title, **fields)
+    if description:
+        model.__doc__ = description
+    return model

{uipath-2.1.84 → uipath-2.1.86}/testcases/apicalls-testcase/run.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 
 echo "Syncing dependencies..."
 uv sync

{uipath-2.1.84 → uipath-2.1.86}/testcases/basic-testcase/run.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+set -e
+
 echo "Syncing dependencies..."
 uv sync
 

{uipath-2.1.84 → uipath-2.1.86}/testcases/common/validate_output.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Common utility to print UiPath output file
-# Usage: source /app/testcases/common/print_output.sh
+# Usage: source /app/testcases/common/validate_output.sh
 
 debug_print_uipath_output() {
     echo "Printing output file..."
@@ -32,4 +32,4 @@ validate_output() {
     echo "Testcase completed successfully."
 }
 
-validate_output
+validate_output

{uipath-2.1.84 → uipath-2.1.86}/testcases/langchain-cross/run.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+set -e
+
 echo "Syncing dependencies..."
 uv sync
 

{uipath-2.1.84 → uipath-2.1.86}/testcases/llamaindex-cross/run.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+set -e
+
 echo "Syncing dependencies..."
 uv sync