uipath 2.0.0.dev2__py3-none-any.whl → 2.0.1.dev1__py3-none-any.whl

uipath/_models/context_grounding_index.py

@@ -0,0 +1,60 @@
+from datetime import datetime
+from typing import Any, List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ContextGroundingField(BaseModel):
+    id: Optional[str] = Field(default=None, alias="id")
+    name: Optional[str] = Field(default=None, alias="name")
+    description: Optional[str] = Field(default=None, alias="description")
+    type: Optional[str] = Field(default=None, alias="type")
+    is_filterable: Optional[bool] = Field(default=None, alias="isFilterable")
+    searchable_type: Optional[str] = Field(default=None, alias="searchableType")
+    is_user_defined: Optional[bool] = Field(default=None, alias="isUserDefined")
+
+
+class ContextGroundingDataSource(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+    id: Optional[str] = Field(default=None, alias="id")
+    folder: Optional[str] = Field(default=None, alias="folder")
+
+
+class ContextGroundingIndex(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+    id: Optional[str] = Field(default=None, alias="id")
+    name: Optional[str] = Field(default=None, alias="name")
+    description: Optional[str] = Field(default=None, alias="description")
+    memory_usage: Optional[int] = Field(default=None, alias="memoryUsage")
+    disk_usage: Optional[int] = Field(default=None, alias="diskUsage")
+    data_source: Optional[ContextGroundingDataSource] = Field(
+        default=None, alias="dataSource"
+    )
+    pre_processing: Any = Field(default=None, alias="preProcessing")
+    fields: Optional[List[ContextGroundingField]] = Field(default=None, alias="fields")
+    last_ingestion_status: Optional[str] = Field(
+        default=None, alias="lastIngestionStatus"
+    )
+    last_ingested: Optional[datetime] = Field(default=None, alias="lastIngested")
+    last_queried: Optional[datetime] = Field(default=None, alias="lastQueried")
+    folder_key: Optional[str] = Field(default=None, alias="folderKey")
+
+    def in_progress_ingestion(self):
+        return (
+            self.last_ingestion_status == "Queued"
+            or self.last_ingestion_status == "In Progress"
+        )

uipath/_models/exceptions.py

@@ -0,0 +1,6 @@
+class IngestionInProgressException(Exception):
+    """An exception that is triggered when a search is attempted on an index that is currently undergoing ingestion."""
+
+    def __init__(self, index_name):
+        self.message = f"index {index_name} cannot be searched during ingestion"
+        super().__init__(self.message)

uipath/_models/interrupt_models.py

@@ -0,0 +1,28 @@
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel
+
+from .actions import Action
+from .job import Job
+
+
+class InvokeProcess(BaseModel):
+    name: str
+    input_arguments: Optional[Dict[str, Any]]
+
+
+class WaitJob(BaseModel):
+    job: Job
+
+
+class CreateAction(BaseModel):
+    name: Optional[str] = None
+    key: Optional[str] = None
+    title: str
+    data: Optional[Dict[str, Any]] = None
+    app_version: Optional[int] = 1
+    assignee: Optional[str] = ""
+
+
+class WaitAction(BaseModel):
+    action: Action

uipath/_models/job.py

@@ -0,0 +1,66 @@
+from datetime import datetime
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class JobErrorInfo(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    code: Optional[str] = Field(default=None, alias="Code")
+    title: Optional[str] = Field(default=None, alias="Title")
+    detail: Optional[str] = Field(default=None, alias="Detail")
+    category: Optional[str] = Field(default=None, alias="Category")
+    status: Optional[str] = Field(default=None, alias="Status")
+
+
+class Job(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    key: Optional[str] = Field(default=None, alias="Key")
+    start_time: Optional[str] = Field(default=None, alias="StartTime")
+    end_time: Optional[str] = Field(default=None, alias="EndTime")
+    state: Optional[str] = Field(default=None, alias="State")
+    job_priority: Optional[str] = Field(default=None, alias="JobPriority")
+    specific_priority_value: Optional[int] = Field(
+        default=None, alias="SpecificPriorityValue"
+    )
+    robot: Optional[Dict[str, Any]] = Field(default=None, alias="Robot")
+    release: Optional[Dict[str, Any]] = Field(default=None, alias="Release")
+    resource_overwrites: Optional[str] = Field(default=None, alias="ResourceOverwrites")
+    source: Optional[str] = Field(default=None, alias="Source")
+    source_type: Optional[str] = Field(default=None, alias="SourceType")
+    batch_execution_key: Optional[str] = Field(default=None, alias="BatchExecutionKey")
+    info: Optional[str] = Field(default=None, alias="Info")
+    creation_time: Optional[str] = Field(default=None, alias="CreationTime")
+    creator_user_id: Optional[int] = Field(default=None, alias="CreatorUserId")
+    last_modification_time: Optional[str] = Field(
+        default=None, alias="LastModificationTime"
+    )
+    last_modifier_user_id: Optional[int] = Field(
+        default=None, alias="LastModifierUserId"
+    )
+    deletion_time: Optional[str] = Field(default=None, alias="DeletionTime")
+    deleter_user_id: Optional[int] = Field(default=None, alias="DeleterUserId")
+    is_deleted: Optional[bool] = Field(default=None, alias="IsDeleted")
+    input_arguments: Optional[str] = Field(default=None, alias="InputArguments")
+    output_arguments: Optional[str] = Field(default=None, alias="OutputArguments")
+    host_machine_name: Optional[str] = Field(default=None, alias="HostMachineName")
+    has_errors: Optional[bool] = Field(default=None, alias="HasErrors")
+    has_warnings: Optional[bool] = Field(default=None, alias="HasWarnings")
+    job_error: Optional[JobErrorInfo] = Field(default=None, alias="JobError")
+    id: int = Field(alias="Id")

uipath/_models/llm_gateway.py

@@ -0,0 +1,101 @@
+from typing import Any, Dict, List, Literal, Optional, Union
+
+from pydantic import BaseModel
+
+
+class EmbeddingItem(BaseModel):
+    embedding: List[float]
+    index: int
+    object: str
+
+
+class EmbeddingUsage(BaseModel):
+    prompt_tokens: int
+    total_tokens: int
+
+
+class TextEmbedding(BaseModel):
+    data: List[EmbeddingItem]
+    model: str
+    object: str
+    usage: EmbeddingUsage
+
+
+class UsageInfo(BaseModel):
+    encoding: str
+    prompt_tokens: int
+
+
+class ToolCall(BaseModel):
+    id: str
+    name: str
+    arguments: Dict[str, Any]
+
+
+class ToolPropertyDefinition(BaseModel):
+    type: str
+    description: Optional[str] = None
+    enum: Optional[List[str]] = None
+
+
+class ToolParametersDefinition(BaseModel):
+    type: str = "object"
+    properties: Dict[str, ToolPropertyDefinition]
+    required: Optional[List[str]] = None
+
+
+class ToolFunctionDefinition(BaseModel):
+    name: str
+    description: Optional[str] = None
+    parameters: ToolParametersDefinition
+
+
+class ToolDefinition(BaseModel):
+    type: Literal["function"] = "function"
+    function: ToolFunctionDefinition
+
+
+class AutoToolChoice(BaseModel):
+    type: Literal["auto"] = "auto"
+
+
+class RequiredToolChoice(BaseModel):
+    type: Literal["required"] = "required"
+
+
+class SpecificToolChoice(BaseModel):
+    type: Literal["tool"] = "tool"
+    name: str
+
+
+ToolChoice = Union[
+    AutoToolChoice, RequiredToolChoice, SpecificToolChoice, Literal["auto", "none"]
+]
+
+
+class ChatMessage(BaseModel):
+    role: str
+    content: Optional[str] = None
+    tool_calls: Optional[List[ToolCall]] = None
+
+
+class ChatCompletionChoice(BaseModel):
+    index: int
+    message: ChatMessage
+    finish_reason: str
+
+
+class ChatCompletionUsage(BaseModel):
+    prompt_tokens: int
+    completion_tokens: int
+    total_tokens: int
+    cache_read_input_tokens: Optional[int] = None
+
+
+class ChatCompletion(BaseModel):
+    id: str
+    object: str
+    created: int
+    model: str
+    choices: List[ChatCompletionChoice]
+    usage: ChatCompletionUsage

uipath/_models/processes.py

@@ -0,0 +1,48 @@
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class Process(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    key: str = Field(alias="Key")
+    process_key: str = Field(alias="ProcessKey")
+    process_version: str = Field(alias="ProcessVersion")
+    is_latest_version: bool = Field(alias="IsLatestVersion")
+    is_process_deleted: bool = Field(alias="IsProcessDeleted")
+    description: str = Field(alias="Description")
+    name: str = Field(alias="Name")
+    environment_variables: Optional[str] = Field(
+        default=None, alias="EnvironmentVariables"
+    )
+    process_type: str = Field(alias="ProcessType")
+    requires_user_interaction: bool = Field(alias="RequiresUserInteraction")
+    is_attended: bool = Field(alias="IsAttended")
+    is_compiled: bool = Field(alias="IsCompiled")
+    feed_id: str = Field(alias="FeedId")
+    job_priority: str = Field(alias="JobPriority")
+    specific_priority_value: int = Field(alias="SpecificPriorityValue")
+    target_framework: str = Field(alias="TargetFramework")
+    id: int = Field(alias="Id")
+    retention_action: str = Field(alias="RetentionAction")
+    retention_period: int = Field(alias="RetentionPeriod")
+    stale_retention_action: str = Field(alias="StaleRetentionAction")
+    stale_retention_period: int = Field(alias="StaleRetentionPeriod")
+    arguments: Optional[Dict[str, Optional[Any]]] = Field(
+        default=None, alias="Arguments"
+    )
+    tags: List[str] = Field(alias="Tags")
+    environment: Optional[str] = Field(default=None, alias="Environment")
+    current_version: Optional[Dict[str, Any]] = Field(
+        default=None, alias="CurrentVersion"
+    )
+    entry_point: Optional[Dict[str, Any]] = Field(default=None, alias="EntryPoint")

uipath/_models/queues.py

@@ -0,0 +1,167 @@
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated
+
+
+class QueueItemPriority(Enum):
+    LOW = "Low"
+    MEDIUM = "Medium"
+    HIGH = "High"
+
+
+class CommitType(Enum):
+    ALL_OR_NOTHING = "AllOrNothing"
+    STOP_ON_FIRST_FAILURE = "StopOnFirstFailure"
+    PROCESS_ALL_INDEPENDENTLY = "ProcessAllIndependently"
+
+
+class QueueItem(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    name: str = Field(
+        description="The name of the queue into which the item will be added.",
+        alias="Name",
+    )
+    priority: Optional[QueueItemPriority] = Field(
+        default=None,
+        description="Sets the processing importance for a given item.",
+        alias="Priority",
+    )
+    specific_content: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="A collection of key value pairs containing custom data configured in the Add Queue Item activity, in UiPath Studio.",
+        alias="SpecificContent",
+    )
+    defer_date: Optional[datetime] = Field(
+        default=None,
+        description="The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.",
+        alias="DeferDate",
+    )
+    due_date: Optional[datetime] = Field(
+        default=None,
+        description="The latest date and time at which the item should be processed. If empty the item can be processed at any given time.",
+        alias="DueDate",
+    )
+    risk_sla_date: Optional[datetime] = Field(
+        default=None,
+        description="The RiskSla date at time which is considered as risk zone for the item to be processed.",
+        alias="RiskSlaDate",
+    )
+    progress: Optional[str] = Field(
+        default=None,
+        description="String field which is used to keep track of the business flow progress.",
+        alias="Progress",
+    )
+    source: Optional[
+        Annotated[str, Field(min_length=0, strict=True, max_length=20)]
+    ] = Field(default=None, description="The Source type of the item.", alias="Source")
+    parent_operation_id: Optional[
+        Annotated[str, Field(min_length=0, strict=True, max_length=128)]
+    ] = Field(
+        default=None,
+        description="Operation id which started the job.",
+        alias="ParentOperationId",
+    )
+
+
+class TransactionItem(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    name: str = Field(
+        description="The name of the queue in which to search for the next item or in which to insert the item before marking it as InProgress and sending it to the robot.",
+        alias="Name",
+    )
+    robot_identifier: Optional[str] = Field(
+        default=None,
+        description="The unique key identifying the robot that sent the request.",
+        alias="RobotIdentifier",
+    )
+    specific_content: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="If not null a new item will be added to the queue with this content before being moved to InProgress state and returned to the robot for processing.  <para />If null the next available item in the list will be moved to InProgress state and returned to the robot for processing.",
+        alias="SpecificContent",
+    )
+    defer_date: Optional[datetime] = Field(
+        default=None,
+        description="The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.",
+        alias="DeferDate",
+    )
+    due_date: Optional[datetime] = Field(
+        default=None,
+        description="The latest date and time at which the item should be processed. If empty the item can be processed at any given time.",
+        alias="DueDate",
+    )
+    parent_operation_id: Optional[
+        Annotated[str, Field(min_length=0, strict=True, max_length=128)]
+    ] = Field(
+        default=None,
+        description="Operation id which created the queue item.",
+        alias="ParentOperationId",
+    )
+
+
+class TransactionItemResult(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+        json_encoders={datetime: lambda v: v.isoformat() if v else None},
+    )
+
+    is_successful: Optional[bool] = Field(
+        default=None,
+        description="States if the processing was successful or not.",
+        alias="IsSuccessful",
+    )
+    processing_exception: Optional[Any] = Field(
+        default=None, alias="ProcessingException"
+    )
+    defer_date: Optional[datetime] = Field(
+        default=None,
+        description="The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.",
+        alias="DeferDate",
+    )
+    due_date: Optional[datetime] = Field(
+        default=None,
+        description="The latest date and time at which the item should be processed. If empty the item can be processed at any given time.",
+        alias="DueDate",
+    )
+    output: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="A collection of key value pairs containing custom data resulted after successful processing.",
+        alias="Output",
+    )
+    analytics: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="A collection of key value pairs containing custom data for further analytics processing.",
+        alias="Analytics",
+    )
+    progress: Optional[str] = Field(
+        default=None,
+        description="String field which is used to keep track of the business flow progress.",
+        alias="Progress",
+    )
+    operation_id: Optional[Annotated[str, Field(strict=True, max_length=128)]] = Field(
+        default=None,
+        description="The operation id which finished the queue item. Will be saved only if queue item is in final state",
+        alias="OperationId",
+    )

uipath/_services/__init__.py

@@ -0,0 +1,26 @@
+from .actions_service import ActionsService
+from .api_client import ApiClient
+from .assets_service import AssetsService
+from .buckets_service import BucketsService
+from .connections_service import ConnectionsService
+from .context_grounding_service import ContextGroundingService
+from .folder_service import FolderService
+from .jobs_service import JobsService
+from .llm_gateway_service import UiPathLlmChatService, UiPathOpenAIService
+from .processes_service import ProcessesService
+from .queues_service import QueuesService
+
+__all__ = [
+    "ActionsService",
+    "AssetsService",
+    "BucketsService",
+    "ConnectionsService",
+    "ContextGroundingService",
+    "ProcessesService",
+    "ApiClient",
+    "QueuesService",
+    "JobsService",
+    "UiPathOpenAIService",
+    "UiPathLlmChatService",
+    "FolderService",
+]