mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2025-09-14 09:19:40 +00:00
308 lines
11 KiB
Python
308 lines
11 KiB
Python
from pydantic_settings import BaseSettings, SettingsConfigDict
|
|
|
|
from skyvern import constants
|
|
from skyvern.constants import SKYVERN_DIR
|
|
|
|
|
|
class Settings(BaseSettings):
|
|
model_config = SettingsConfigDict(env_file=(".env", ".env.staging", ".env.prod"), extra="ignore")
|
|
|
|
ADDITIONAL_MODULES: list[str] = []
|
|
|
|
BROWSER_TYPE: str = "chromium-headful"
|
|
BROWSER_REMOTE_DEBUGGING_URL: str = "http://127.0.0.1:9222"
|
|
CHROME_EXECUTABLE_PATH: str | None = None
|
|
MAX_SCRAPING_RETRIES: int = 0
|
|
VIDEO_PATH: str | None = "./video"
|
|
HAR_PATH: str | None = "./har"
|
|
LOG_PATH: str = "./log"
|
|
TEMP_PATH: str = "./temp"
|
|
BROWSER_ACTION_TIMEOUT_MS: int = 5000
|
|
BROWSER_SCREENSHOT_TIMEOUT_MS: int = 20000
|
|
BROWSER_LOADING_TIMEOUT_MS: int = 90000
|
|
OPTION_LOADING_TIMEOUT_MS: int = 600000
|
|
MAX_STEPS_PER_RUN: int = 10
|
|
MAX_STEPS_PER_TASK_V2: int = 25
|
|
MAX_ITERATIONS_PER_TASK_V2: int = 10
|
|
MAX_NUM_SCREENSHOTS: int = 10
|
|
# Ratio should be between 0 and 1.
|
|
# If the task has been running for more steps than this ratio of the max steps per run, then we'll log a warning.
|
|
LONG_RUNNING_TASK_WARNING_RATIO: float = 0.95
|
|
MAX_RETRIES_PER_STEP: int = 5
|
|
DEBUG_MODE: bool = False
|
|
DATABASE_STRING: str = "postgresql+psycopg://skyvern@localhost/skyvern"
|
|
DATABASE_STATEMENT_TIMEOUT_MS: int = 60000
|
|
DISABLE_CONNECTION_POOL: bool = False
|
|
PROMPT_ACTION_HISTORY_WINDOW: int = 1
|
|
TASK_RESPONSE_ACTION_SCREENSHOT_COUNT: int = 3
|
|
|
|
ENV: str = "local"
|
|
EXECUTE_ALL_STEPS: bool = True
|
|
JSON_LOGGING: bool = False
|
|
LOG_LEVEL: str = "INFO"
|
|
PORT: int = 8000
|
|
ALLOWED_ORIGINS: list[str] = ["*"]
|
|
BLOCKED_HOSTS: list[str] = ["localhost"]
|
|
ALLOWED_HOSTS: list[str] = []
|
|
|
|
# Format: "http://<username>:<password>@host:port, http://<username>:<password>@host:port, ...."
|
|
HOSTED_PROXY_POOL: str = ""
|
|
ENABLE_PROXY: bool = False
|
|
|
|
# Secret key for JWT. Please generate your own secret key in production
|
|
SECRET_KEY: str = "PLACEHOLDER"
|
|
# Algorithm used to sign the JWT
|
|
SIGNATURE_ALGORITHM: str = "HS256"
|
|
ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 7 # one week
|
|
|
|
# Artifact storage settings
|
|
ARTIFACT_STORAGE_PATH: str = f"{SKYVERN_DIR}/artifacts"
|
|
GENERATE_PRESIGNED_URLS: bool = False
|
|
AWS_S3_BUCKET_ARTIFACTS: str = "skyvern-artifacts"
|
|
AWS_S3_BUCKET_SCREENSHOTS: str = "skyvern-screenshots"
|
|
AWS_S3_BUCKET_BROWSER_SESSIONS: str = "skyvern-browser-sessions"
|
|
|
|
# Supported storage types: local, s3
|
|
SKYVERN_STORAGE_TYPE: str = "local"
|
|
|
|
# S3 bucket settings
|
|
AWS_REGION: str = "us-east-1"
|
|
AWS_S3_BUCKET_UPLOADS: str = "skyvern-uploads"
|
|
MAX_UPLOAD_FILE_SIZE: int = 10 * 1024 * 1024 # 10 MB
|
|
PRESIGNED_URL_EXPIRATION: int = 60 * 60 * 24 # 24 hours
|
|
|
|
SKYVERN_TELEMETRY: bool = True
|
|
ANALYTICS_ID: str = "anonymous"
|
|
|
|
# browser settings
|
|
BROWSER_LOCALE: str = "en-US"
|
|
BROWSER_TIMEZONE: str = "America/New_York"
|
|
BROWSER_WIDTH: int = 1920
|
|
BROWSER_HEIGHT: int = 1080
|
|
|
|
# Add extension folders name here to load extension in your browser
|
|
EXTENSIONS_BASE_PATH: str = "./extensions"
|
|
EXTENSIONS: list[str] = []
|
|
|
|
# Workflow constant parameters
|
|
WORKFLOW_DOWNLOAD_DIRECTORY_PARAMETER_KEY: str = "SKYVERN_DOWNLOAD_DIRECTORY"
|
|
WORKFLOW_WAIT_BLOCK_MAX_SEC: int = 30 * 60
|
|
|
|
# Saved browser session settings
|
|
BROWSER_SESSION_BASE_PATH: str = f"{constants.REPO_ROOT_DIR}/browser_sessions"
|
|
|
|
#####################
|
|
# Bitwarden Configs #
|
|
#####################
|
|
BITWARDEN_TIMEOUT_SECONDS: int = 60
|
|
BITWARDEN_MAX_RETRIES: int = 2
|
|
|
|
# task generation settings
|
|
PROMPT_CACHE_WINDOW_HOURS: int = 24
|
|
|
|
#####################
|
|
# LLM Configuration #
|
|
#####################
|
|
# ACTIVE LLM PROVIDER
|
|
LLM_KEY: str = "OPENAI_GPT4O" # This is the model name
|
|
LLM_API_KEY: str | None = None # API key for the model
|
|
SECONDARY_LLM_KEY: str | None = None
|
|
SELECT_AGENT_LLM_KEY: str | None = None
|
|
SINGLE_CLICK_AGENT_LLM_KEY: str | None = None
|
|
PROMPT_BLOCK_LLM_KEY: str | None = None
|
|
# COMMON
|
|
LLM_CONFIG_TIMEOUT: int = 300
|
|
LLM_CONFIG_MAX_TOKENS: int = 4096
|
|
LLM_CONFIG_TEMPERATURE: float = 0
|
|
LLM_CONFIG_SUPPORT_VISION: bool = True # Whether the model supports vision
|
|
LLM_CONFIG_ADD_ASSISTANT_PREFIX: bool = False # Whether to add assistant prefix
|
|
# LLM PROVIDER SPECIFIC
|
|
ENABLE_OPENAI: bool = False
|
|
ENABLE_ANTHROPIC: bool = False
|
|
ENABLE_BEDROCK_ANTHROPIC: bool = False
|
|
ENABLE_AZURE: bool = False
|
|
ENABLE_AZURE_GPT4O_MINI: bool = False
|
|
ENABLE_AZURE_O3_MINI: bool = False
|
|
ENABLE_BEDROCK: bool = False
|
|
ENABLE_GEMINI: bool = False
|
|
ENABLE_VERTEX_AI: bool = False
|
|
ENABLE_AZURE_CUA: bool = False
|
|
ENABLE_OPENAI_COMPATIBLE: bool = False
|
|
# OPENAI
|
|
OPENAI_API_KEY: str | None = None
|
|
# ANTHROPIC
|
|
ANTHROPIC_API_KEY: str | None = None
|
|
ANTHROPIC_CUA_LLM_KEY: str = "ANTHROPIC_CLAUDE3.7_SONNET"
|
|
|
|
# OPENAI COMPATIBLE
|
|
OPENAI_COMPATIBLE_MODEL_NAME: str | None = None
|
|
OPENAI_COMPATIBLE_API_KEY: str | None = None
|
|
OPENAI_COMPATIBLE_API_BASE: str | None = None
|
|
OPENAI_COMPATIBLE_API_VERSION: str | None = None
|
|
OPENAI_COMPATIBLE_MAX_TOKENS: int | None = None
|
|
OPENAI_COMPATIBLE_TEMPERATURE: float | None = None
|
|
OPENAI_COMPATIBLE_SUPPORTS_VISION: bool = False
|
|
OPENAI_COMPATIBLE_ADD_ASSISTANT_PREFIX: bool = False
|
|
OPENAI_COMPATIBLE_MODEL_KEY: str = "OPENAI_COMPATIBLE"
|
|
OPENAI_COMPATIBLE_REASONING_EFFORT: str | None = None
|
|
|
|
# AZURE
|
|
AZURE_DEPLOYMENT: str | None = None
|
|
AZURE_API_KEY: str | None = None
|
|
AZURE_API_BASE: str | None = None
|
|
AZURE_API_VERSION: str | None = None
|
|
AZURE_CUA_API_KEY: str | None = None
|
|
AZURE_CUA_ENDPOINT: str | None = None
|
|
AZURE_CUA_DEPLOYMENT: str | None = "computer-use-preview"
|
|
AZURE_CUA_API_VERSION: str | None = "2025-03-01-preview"
|
|
|
|
# AZURE GPT-4o mini
|
|
AZURE_GPT4O_MINI_DEPLOYMENT: str | None = None
|
|
AZURE_GPT4O_MINI_API_KEY: str | None = None
|
|
AZURE_GPT4O_MINI_API_BASE: str | None = None
|
|
AZURE_GPT4O_MINI_API_VERSION: str | None = None
|
|
|
|
# AZURE o3 mini
|
|
AZURE_O3_MINI_DEPLOYMENT: str | None = None
|
|
AZURE_O3_MINI_API_KEY: str | None = None
|
|
AZURE_O3_MINI_API_BASE: str | None = None
|
|
AZURE_O3_MINI_API_VERSION: str | None = None
|
|
|
|
# AZURE gpt-4.1
|
|
ENABLE_AZURE_GPT4_1: bool = False
|
|
AZURE_GPT4_1_DEPLOYMENT: str = "gpt-4.1"
|
|
AZURE_GPT4_1_API_KEY: str | None = None
|
|
AZURE_GPT4_1_API_BASE: str | None = None
|
|
AZURE_GPT4_1_API_VERSION: str = "2025-01-01-preview"
|
|
|
|
# AZURE gpt-4.1 mini
|
|
ENABLE_AZURE_GPT4_1_MINI: bool = False
|
|
AZURE_GPT4_1_MINI_DEPLOYMENT: str = "gpt-4.1-mini"
|
|
AZURE_GPT4_1_MINI_API_KEY: str | None = None
|
|
AZURE_GPT4_1_MINI_API_BASE: str | None = None
|
|
AZURE_GPT4_1_MINI_API_VERSION: str = "2025-01-01-preview"
|
|
|
|
# AZURE gpt-4.1 nano
|
|
ENABLE_AZURE_GPT4_1_NANO: bool = False
|
|
AZURE_GPT4_1_NANO_DEPLOYMENT: str = "gpt-4.1-nano"
|
|
AZURE_GPT4_1_NANO_API_KEY: str | None = None
|
|
AZURE_GPT4_1_NANO_API_BASE: str | None = None
|
|
AZURE_GPT4_1_NANO_API_VERSION: str = "2025-01-01-preview"
|
|
|
|
# AZURE o4-mini
|
|
ENABLE_AZURE_O4_MINI: bool = False
|
|
AZURE_O4_MINI_DEPLOYMENT: str = "o4-mini"
|
|
AZURE_O4_MINI_API_KEY: str | None = None
|
|
AZURE_O4_MINI_API_BASE: str | None = None
|
|
AZURE_O4_MINI_API_VERSION: str = "2025-01-01-preview"
|
|
|
|
# AZURE o3
|
|
ENABLE_AZURE_O3: bool = False
|
|
AZURE_O3_DEPLOYMENT: str = "o3"
|
|
AZURE_O3_API_KEY: str | None = None
|
|
AZURE_O3_API_BASE: str | None = None
|
|
AZURE_O3_API_VERSION: str = "2025-01-01-preview"
|
|
|
|
# GEMINI
|
|
GEMINI_API_KEY: str | None = None
|
|
|
|
# VERTEX_AI
|
|
VERTEX_CREDENTIALS: str | None = None
|
|
VERTEX_PROJECT_ID: str | None = None
|
|
VERTEX_LOCATION: str | None = None
|
|
|
|
# NOVITA AI
|
|
ENABLE_NOVITA: bool = False
|
|
NOVITA_API_KEY: str | None = None
|
|
NOVITA_API_VERSION: str = "v3"
|
|
|
|
# OLLAMA
|
|
ENABLE_OLLAMA: bool = False
|
|
OLLAMA_SERVER_URL: str | None = None
|
|
OLLAMA_MODEL: str | None = None
|
|
|
|
# OPENROUTER
|
|
ENABLE_OPENROUTER: bool = False
|
|
OPENROUTER_API_KEY: str | None = None
|
|
OPENROUTER_MODEL: str | None = None
|
|
OPENROUTER_API_BASE: str = "https://api.openrouter.ai/v1"
|
|
|
|
# GROQ
|
|
ENABLE_GROQ: bool = False
|
|
GROQ_API_KEY: str | None = None
|
|
GROQ_MODEL: str | None = None
|
|
GROQ_API_BASE: str = "https://api.groq.com/openai/v1"
|
|
|
|
# TOTP Settings
|
|
TOTP_LIFESPAN_MINUTES: int = 10
|
|
VERIFICATION_CODE_INITIAL_WAIT_TIME_SECS: int = 40
|
|
VERIFICATION_CODE_POLLING_TIMEOUT_MINS: int = 15
|
|
|
|
# Bitwarden Settings
|
|
BITWARDEN_CLIENT_ID: str | None = None
|
|
BITWARDEN_CLIENT_SECRET: str | None = None
|
|
BITWARDEN_MASTER_PASSWORD: str | None = None
|
|
|
|
# Skyvern Auth Bitwarden Settings
|
|
SKYVERN_AUTH_BITWARDEN_CLIENT_ID: str | None = None
|
|
SKYVERN_AUTH_BITWARDEN_CLIENT_SECRET: str | None = None
|
|
SKYVERN_AUTH_BITWARDEN_MASTER_PASSWORD: str | None = None
|
|
SKYVERN_AUTH_BITWARDEN_ORGANIZATION_ID: str | None = None
|
|
|
|
BITWARDEN_SERVER: str = "http://localhost"
|
|
BITWARDEN_SERVER_PORT: int = 8002
|
|
|
|
SVG_MAX_LENGTH: int = 100000
|
|
|
|
ENABLE_LOG_ARTIFACTS: bool = False
|
|
ENABLE_CODE_BLOCK: bool = False
|
|
|
|
TASK_BLOCKED_SITE_FALLBACK_URL: str = "https://www.google.com"
|
|
|
|
SKYVERN_APP_URL: str = "http://localhost:8080"
|
|
# SkyvernClient Settings
|
|
SKYVERN_BASE_URL: str = "https://api.skyvern.com"
|
|
SKYVERN_API_KEY: str = "PLACEHOLDER"
|
|
|
|
def get_model_name_to_llm_key(self) -> dict[str, str]:
|
|
"""
|
|
Keys are model names available to blocks in the frontend. These map to key names
|
|
in LLMConfigRegistry._configs.
|
|
"""
|
|
|
|
if self.is_cloud_environment():
|
|
return {
|
|
"Gemini 2.5": "GEMINI_2.5_PRO_PREVIEW",
|
|
"Gemini 2.5 Flash": "VERTEX_GEMINI_2.5_FLASH_PREVIEW_05_20",
|
|
"GPT 4.1": "OPENAI_GPT4_1",
|
|
"GPT o3-mini": "OPENAI_O3_MINI",
|
|
}
|
|
else:
|
|
# TODO: apparently the list for OSS is to be much larger
|
|
return {
|
|
"Gemini 2.5": "GEMINI_2.5_PRO_PREVIEW",
|
|
"Gemini 2.5 Flash": "VERTEX_GEMINI_2.5_FLASH_PREVIEW_05_20",
|
|
"GPT 4.1": "OPENAI_GPT4_1",
|
|
"GPT o3-mini": "OPENAI_O3_MINI",
|
|
}
|
|
|
|
def is_cloud_environment(self) -> bool:
|
|
"""
|
|
:return: True if env is not local, else False
|
|
"""
|
|
return self.ENV != "local"
|
|
|
|
def execute_all_steps(self) -> bool:
|
|
"""
|
|
This provides the functionality to execute steps one by one through the Streamlit UI.
|
|
***Value is always True if ENV is not local.***
|
|
|
|
:return: True if env is not local, else the value of EXECUTE_ALL_STEPS
|
|
"""
|
|
if self.is_cloud_environment():
|
|
return True
|
|
else:
|
|
return self.EXECUTE_ALL_STEPS
|
|
|
|
|
|
settings = Settings()
|