mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2025-09-01 10:09:58 +00:00
a4744ed9f5
Co-authored-by: Shuchang Zheng <wintonzheng0325@gmail.com> Co-authored-by: Shuchang Zheng <shu@skyvern.com>
141 lines
4.1 KiB
Python
141 lines
4.1 KiB
Python
from datetime import datetime
|
|
from enum import StrEnum
|
|
from typing import Any, List
|
|
|
|
from pydantic import BaseModel, field_validator
|
|
|
|
from skyvern.forge.sdk.core.validators import validate_url
|
|
from skyvern.forge.sdk.schemas.observers import ObserverCruise
|
|
from skyvern.forge.sdk.schemas.tasks import ProxyLocation
|
|
from skyvern.forge.sdk.workflow.exceptions import WorkflowDefinitionHasDuplicateBlockLabels
|
|
from skyvern.forge.sdk.workflow.models.block import BlockTypeVar
|
|
from skyvern.forge.sdk.workflow.models.parameter import PARAMETER_TYPE
|
|
|
|
|
|
class WorkflowRequestBody(BaseModel):
|
|
data: dict[str, Any] | None = None
|
|
proxy_location: ProxyLocation | None = None
|
|
webhook_callback_url: str | None = None
|
|
totp_verification_url: str | None = None
|
|
totp_identifier: str | None = None
|
|
browser_session_id: str | None = None
|
|
|
|
@field_validator("webhook_callback_url", "totp_verification_url")
|
|
@classmethod
|
|
def validate_urls(cls, url: str | None) -> str | None:
|
|
if url is None:
|
|
return None
|
|
return validate_url(url)
|
|
|
|
|
|
class RunWorkflowResponse(BaseModel):
|
|
workflow_id: str
|
|
workflow_run_id: str
|
|
|
|
|
|
class WorkflowDefinition(BaseModel):
|
|
parameters: list[PARAMETER_TYPE]
|
|
blocks: List[BlockTypeVar]
|
|
|
|
def validate(self) -> None:
|
|
labels: set[str] = set()
|
|
duplicate_labels: set[str] = set()
|
|
for block in self.blocks:
|
|
if block.label in labels:
|
|
duplicate_labels.add(block.label)
|
|
else:
|
|
labels.add(block.label)
|
|
|
|
if duplicate_labels:
|
|
raise WorkflowDefinitionHasDuplicateBlockLabels(duplicate_labels)
|
|
|
|
|
|
class Workflow(BaseModel):
|
|
workflow_id: str
|
|
organization_id: str
|
|
title: str
|
|
workflow_permanent_id: str
|
|
version: int
|
|
is_saved_task: bool
|
|
description: str | None = None
|
|
workflow_definition: WorkflowDefinition
|
|
proxy_location: ProxyLocation | None = None
|
|
webhook_callback_url: str | None = None
|
|
totp_verification_url: str | None = None
|
|
totp_identifier: str | None = None
|
|
persist_browser_session: bool = False
|
|
|
|
created_at: datetime
|
|
modified_at: datetime
|
|
deleted_at: datetime | None = None
|
|
|
|
|
|
class WorkflowRunStatus(StrEnum):
|
|
created = "created"
|
|
queued = "queued"
|
|
running = "running"
|
|
failed = "failed"
|
|
terminated = "terminated"
|
|
canceled = "canceled"
|
|
timed_out = "timed_out"
|
|
completed = "completed"
|
|
|
|
def is_final(self) -> bool:
|
|
return self in [
|
|
WorkflowRunStatus.failed,
|
|
WorkflowRunStatus.terminated,
|
|
WorkflowRunStatus.canceled,
|
|
WorkflowRunStatus.timed_out,
|
|
WorkflowRunStatus.completed,
|
|
]
|
|
|
|
|
|
class WorkflowRun(BaseModel):
|
|
workflow_run_id: str
|
|
workflow_id: str
|
|
workflow_permanent_id: str
|
|
organization_id: str
|
|
status: WorkflowRunStatus
|
|
proxy_location: ProxyLocation | None = None
|
|
webhook_callback_url: str | None = None
|
|
totp_verification_url: str | None = None
|
|
totp_identifier: str | None = None
|
|
failure_reason: str | None = None
|
|
|
|
created_at: datetime
|
|
modified_at: datetime
|
|
|
|
|
|
class WorkflowRunParameter(BaseModel):
|
|
workflow_run_id: str
|
|
workflow_parameter_id: str
|
|
value: bool | int | float | str | dict | list
|
|
created_at: datetime
|
|
|
|
|
|
class WorkflowRunOutputParameter(BaseModel):
|
|
workflow_run_id: str
|
|
output_parameter_id: str
|
|
value: dict[str, Any] | list | str | None
|
|
created_at: datetime
|
|
|
|
|
|
class WorkflowRunStatusResponse(BaseModel):
|
|
workflow_id: str
|
|
workflow_run_id: str
|
|
status: WorkflowRunStatus
|
|
failure_reason: str | None = None
|
|
proxy_location: ProxyLocation | None = None
|
|
webhook_callback_url: str | None = None
|
|
totp_verification_url: str | None = None
|
|
totp_identifier: str | None = None
|
|
created_at: datetime
|
|
modified_at: datetime
|
|
parameters: dict[str, Any]
|
|
screenshot_urls: list[str] | None = None
|
|
recording_url: str | None = None
|
|
downloaded_file_urls: list[str] | None = None
|
|
outputs: dict[str, Any] | None = None
|
|
total_steps: int | None = None
|
|
total_cost: float | None = None
|
|
observer_cruise: ObserverCruise | None = None
|