uipath 2.1.98__tar.gz → 2.1.100__tar.gz

{uipath-2.1.98 → uipath-2.1.100}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.98
+Version: 2.1.100
 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.100/docs/AutomationSuite.md

@@ -0,0 +1,150 @@
+# Automation Suite
+
+## Airgapped Deployments
+
+Airgapped Automation Suite environments (deployments without internet access) require special configuration for Python package dependencies. You need to configure your project to use a Python package feed that is accessible within your environment.
+
+You have two main options for managing Python packages:
+
+1. **Use Azure DevOps Artifacts** - Leverage Azure DevOps as a Python package feed with upstream PyPI sources (suitable for environments with restricted but not fully airgapped access)
+2. **Host your own Python package index** - Set up a self-hosted PyPI mirror or repository within your infrastructure (required for truly airgapped environments)
+
+### Using Azure DevOps Artifacts as a Python Feed
+
+Azure DevOps Artifacts can serve as a private Python package feed that includes packages from common public sources (PyPI). This is suitable for environments with restricted internet access where Azure DevOps services are still accessible.
+
+#### Step 1: Create an Azure DevOps Artifacts Feed
+
+1. Navigate to your Azure DevOps project
+2. Go to **Artifacts**
+3. Click **Create Feed**
+4. Configure your feed settings and ensure you select the option to **Include packages from common public sources** (this will upstream PyPI packages)
+
+#### Step 2: Authenticate with a Personal Access Token (PAT)
+
+You'll need to create a Personal Access Token (PAT) to authenticate with your Azure DevOps feed.
+
+1. Follow the [Microsoft documentation to create a PAT](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows)
+2. Ensure your PAT has at least **Packaging (Read)** permissions
+3. Save your PAT securely - you'll need it for the next step
+
+#### Step 3: Configure Your Project
+
+Add the following configuration to your `pyproject.toml` file:
+
+```toml
+[[tool.uv.index]]
+name = "my-feed"
+url = "https://az:PAT_STRING@YOUR_ORG.pkgs.visualstudio.com/YourProject/_packaging/my-feed/pypi/simple/"
+publish-url = "https://az:PAT_STRING@YOUR_ORG.pkgs.visualstudio.com/YourProject/_packaging/my-feed/pypi/upload/"
+default = true
+```
+
+Replace the following placeholders:
+
+- **`PAT_STRING`**: Your actual Personal Access Token from Step 2
+- **`YOUR_ORG`**: Your Azure DevOps organization name
+- **`YourProject`**: Your Azure DevOps project name
+- **`my-feed`**: The name of your feed (in both the `name` field and the URL)
+
+/// tip
+**Organization-scoped feeds**: If you're using an organization-scoped feed instead of a project-scoped feed, the URL format will be slightly different, but the same authentication logic applies. The URL will follow this pattern:
+
+```toml
+url = "https://az:PAT_STRING@YOUR_ORG.pkgs.visualstudio.com/_packaging/my-feed/pypi/simple/"
+```
+
+Note the absence of the project name in the URL path.
+///
+
+/// tip
+**Using environment variables**: You can also configure the feed URL using environment variables instead of hardcoding the PAT in `pyproject.toml`:
+
+```toml
+[[tool.uv.index]]
+name = "my-feed"
+url = "https://az:${AZURE_DEVOPS_PAT}@YOUR_ORG.pkgs.visualstudio.com/YourProject/_packaging/my-feed/pypi/simple/"
+default = true # to use this feed as your default
+```
+
+Then set the environment variable before running your commands locally:
+
+```bash
+export AZURE_DEVOPS_PAT=your_pat_token
+```
+
+**Important**: When deploying your process to UiPath, you'll need to configure these environment variables in the process settings. Navigate to your process in UiPath Orchestrator and add the environment variables (e.g., `AZURE_DEVOPS_PAT`) with their corresponding values. This ensures your process can authenticate with the external feed when running in the UiPath environment.
+///
+
+/// tip
+**Specifying sources for specific packages**: If you don't want to set your custom feed as the default, you can use `[tool.uv.sources]` to specify which packages should come from your custom feed:
+
+```toml
+[[tool.uv.index]]
+name = "my-feed"
+url = "https://az:PAT_STRING@YOUR_ORG.pkgs.visualstudio.com/YourProject/_packaging/my-feed/pypi/simple/"
+
+[tool.uv.sources]
+uipath = { index = "my-feed" }
+# Add other packages as needed
+some-private-package = { index = "my-feed" }
+```
+
+This allows you to selectively pull specific packages from your custom feed while using the default PyPI for others.
+///
+
+#### Step 4: Install Dependencies
+
+Once configured, you can install dependencies using `uv`:
+
+<!-- termynal -->
+```bash
+> uv add uipath
+⠋ Resolved 25 packages from my-feed
+✓  Successfully installed uipath
+```
+
+#### Verification
+
+To verify your feed configuration is working correctly, you can check that `uv` resolves packages from your custom feed:
+
+<!-- termynal -->
+```bash
+> uv add --dry-run uipath
+⠋ Checking package availability...
+✓  All packages available from my-feed
+```
+
+### Hosting Your Own Python Package Index
+
+For truly airgapped deployments where you need complete control over your infrastructure, you can host your own Python package index within your network. This approach eliminates any external dependencies and provides full control over the packages available in your environment.
+
+#### Popular Self-Hosted Solutions
+
+Several tools are available for hosting a Python package index:
+
+- **[devpi](https://devpi.net/)** - A PyPI-compatible server with caching and mirroring capabilities
+- **[PyPI Server](https://pypi.org/project/pypiserver/)** - A minimal PyPI-compatible server for hosting packages
+- **[JFrog Artifactory](https://jfrog.com/artifactory/)** - Enterprise artifact repository with Python support
+- **[Sonatype Nexus Repository](https://www.sonatype.com/products/nexus-repository)** - Universal artifact repository manager
+- **[bandersnatch](https://github.com/pypa/bandersnatch)** - PyPI mirror client for creating a complete or filtered mirror
+
+#### Configuration for Self-Hosted Index
+
+Once you have your Python package index set up and accessible within your airgapped network, configure your `pyproject.toml` to point to it:
+
+```toml
+[[tool.uv.index]]
+name = "internal-pypi"
+url = "https://pypi.internal.company.com/simple/"
+default = true
+```
+
+If your internal index requires authentication:
+
+```toml
+[[tool.uv.index]]
+name = "internal-pypi"
+url = "https://username:password@pypi.internal.company.com/simple/"
+default = true
+```

{uipath-2.1.98 → uipath-2.1.100}/mkdocs.yml

@@ -89,6 +89,7 @@ nav:
       - Sample Agents: https://github.com/UiPath/uipath-llamaindex-python/tree/main/samples
   - How To Contribute: CONTRIBUTING.md
   - FAQ: FAQ.md
+  - Automation Suite: AutomationSuite.md
   - Release Policy: release_policy.md
 
 plugins:

{uipath-2.1.98 → uipath-2.1.100}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.98"
+version = "2.1.100"
 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"
@@ -76,9 +76,7 @@ dev = [
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/uipath"]
-include = [
-    "src/uipath/_resources"
-]
+include = ["src/uipath/_resources"]
 
 [tool.ruff]
 line-length = 88

{uipath-2.1.98 → uipath-2.1.100}/src/uipath/_cli/cli_init.py

@@ -60,18 +60,25 @@ def generate_env_file(target_directory):
         console.success(f"Created '{relative_path}' file.")
 
 
-def generate_agent_md_file(target_directory: str, file_name: str) -> None:
+def generate_agent_md_file(
+    target_directory: str, file_name: str, no_agents_md_override: bool
+) -> bool:
     """Generate an agent-specific file from the packaged resource.
 
     Args:
         target_directory: The directory where the file should be created.
         file_name: The name of the file should be created.
+        no_agents_md_override: Whether to override existing files.
     """
     target_path = os.path.join(target_directory, file_name)
 
-    if os.path.exists(target_path):
-        logger.debug(f"File '{target_path}' already exists.")
-        return
+    will_override = os.path.exists(target_path)
+
+    if will_override and no_agents_md_override:
+        console.success(
+            f"File {click.style(target_path, fg='cyan')} already exists. Skipping."
+        )
+        return False
 
     try:
         source_path = importlib.resources.files("uipath._resources").joinpath(file_name)
@@ -79,15 +86,23 @@ def generate_agent_md_file(target_directory: str, file_name: str) -> None:
         with importlib.resources.as_file(source_path) as s_path:
             shutil.copy(s_path, target_path)
 
+        if will_override:
+            logger.debug(f"File '{target_path}' has been overridden.")
+
+        return will_override
+
     except Exception as e:
         console.warning(f"Could not create {file_name}: {e}")
 
+    return False
+
 
-def generate_agent_md_files(target_directory: str) -> None:
+def generate_agent_md_files(target_directory: str, no_agents_md_override: bool) -> None:
     """Generate an agent-specific file from the packaged resource.
 
     Args:
         target_directory: The directory where the files should be created.
+        no_agents_md_override: Whether to override existing files.
     """
     agent_dir = os.path.join(target_directory, ".agent")
     os.makedirs(agent_dir, exist_ok=True)
@@ -96,13 +111,21 @@ def generate_agent_md_files(target_directory: str) -> None:
 
     agent_files = ["CLI_REFERENCE.md", "REQUIRED_STRUCTURE.md", "SDK_REFERENCE.md"]
 
+    any_overridden = False
+
     for file_name in root_files:
-        generate_agent_md_file(target_directory, file_name)
+        if generate_agent_md_file(target_directory, file_name, no_agents_md_override):
+            any_overridden = True
 
     for file_name in agent_files:
-        generate_agent_md_file(agent_dir, file_name)
+        if generate_agent_md_file(agent_dir, file_name, no_agents_md_override):
+            any_overridden = True
 
-    console.success(f"Created {click.style('AGENTS.md', fg='cyan')} file.")
+    if any_overridden:
+        console.success(f"Updated {click.style('AGENTS.md', fg='cyan')} related files.")
+        return
+
+    console.success(f"Created {click.style('AGENTS.md', fg='cyan')} related files.")
 
 
 def get_existing_settings(config_path: str) -> Optional[Dict[str, Any]]:
@@ -149,8 +172,15 @@ def write_config_file(config_data: Dict[str, Any] | RuntimeSchema) -> None:
     default=True,
     help="Infer bindings from the script.",
 )
+@click.option(
+    "--no-agents-md-override",
+    is_flag=True,
+    required=False,
+    default=False,
+    help="Won't override existing .agent files and AGENTS.md file.",
+)
 @track
-def init(entrypoint: str, infer_bindings: bool) -> None:
+def init(entrypoint: str, infer_bindings: bool, no_agents_md_override: bool) -> None:
     """Create uipath.json with input/output schemas and bindings."""
     with console.spinner("Initializing UiPath project ..."):
         current_directory = os.getcwd()
@@ -160,7 +190,10 @@ def init(entrypoint: str, infer_bindings: bool) -> None:
         result = Middlewares.next(
             "init",
             entrypoint,
-            options={"infer_bindings": infer_bindings},
+            options={
+                "infer_bindings": infer_bindings,
+                "no_agents_md_override": no_agents_md_override,
+            },
             write_config=write_config_file,
         )
 
@@ -175,7 +208,7 @@ def init(entrypoint: str, infer_bindings: bool) -> None:
         if not result.should_continue:
             return
 
-        generate_agent_md_files(current_directory)
+        generate_agent_md_files(current_directory, no_agents_md_override)
         script_path = get_user_script(current_directory, entrypoint=entrypoint)
         if not script_path:
             return

{uipath-2.1.98 → uipath-2.1.100}/src/uipath/_resources/CLI_REFERENCE.md

@@ -27,6 +27,7 @@ The UiPath Python SDK provides a comprehensive CLI for managing coded agents and
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `--infer-bindings` | flag | false | Infer bindings from the script. |
+| `--no-agents-md-override` | flag | false | Won't override existing .agent files and AGENTS.md file. |
 
 **Usage Examples:**
 

{uipath-2.1.98 → uipath-2.1.100}/src/uipath/_services/documents_service.py

@@ -27,6 +27,10 @@ class DocumentsService(FolderContext, BaseService):
     """Service for managing UiPath DocumentUnderstanding Document Operations.
 
     This service provides methods to extract data from documents using UiPath's Document Understanding capabilities.
+
+    !!! warning "Preview Feature"
+        This function is currently experimental.
+        Behavior and parameters are subject to change in future versions.
     """
 
     def __init__(self, config: Config, execution_context: ExecutionContext) -> None:

{uipath-2.1.98 → uipath-2.1.100}/src/uipath/agent/models/agent.py

@@ -6,6 +6,7 @@ from typing import Annotated, Any, Dict, List, Literal, Optional, Union
 from pydantic import BaseModel, ConfigDict, Discriminator, Field, Tag, field_validator
 
 from uipath.models import Connection
+from uipath.models.guardrails import AgentEscalationRecipient, Guardrail
 
 
 class AgentResourceType(str, Enum):
@@ -305,39 +306,6 @@ class AgentMcpResourceConfig(BaseAgentResourceConfig):
     )
 
 
-class AgentEscalationRecipientType(str, Enum):
-    """Enum for escalation recipient types."""
-
-    USER_ID = "UserId"
-    GROUP_ID = "GroupId"
-    USER_EMAIL = "UserEmail"
-
-
-class AgentEscalationRecipient(BaseModel):
-    """Recipient for escalation."""
-
-    type: Union[AgentEscalationRecipientType, str] = Field(..., alias="type")
-    value: str = Field(..., alias="value")
-    display_name: Optional[str] = Field(default=None, alias="displayName")
-
-    @field_validator("type", mode="before")
-    @classmethod
-    def normalize_type(cls, v: Any) -> str:
-        """Normalize recipient type from int (1=UserId, 2=GroupId, 3=UserEmail) or string. Unknown integers are converted to string."""
-        if isinstance(v, int):
-            mapping = {
-                1: AgentEscalationRecipientType.USER_ID,
-                2: AgentEscalationRecipientType.GROUP_ID,
-                3: AgentEscalationRecipientType.USER_EMAIL,
-            }
-            return mapping.get(v, str(v))
-        return v
-
-    model_config = ConfigDict(
-        validate_by_name=True, validate_by_alias=True, extra="allow"
-    )
-
-
 class AgentEscalationChannelProperties(BaseResourceProperties):
     """Agent escalation channel properties."""
 
@@ -508,6 +476,9 @@ class BaseAgentDefinition(BaseModel):
     output_schema: Dict[str, Any] = Field(
         ..., alias="outputSchema", description="JSON schema for output arguments"
     )
+    guardrails: Optional[List[Guardrail]] = Field(
+        None, description="List of agent guardrails"
+    )
 
     model_config = ConfigDict(
         validate_by_name=True, validate_by_alias=True, extra="allow"