Skip to content

Automate browser based workflows with AI

Add browser_metadata field with website_url to step output (#5102)

Shuchang Zheng5ef7bc89e8bb
diff --git a/skyvern/schemas/steps.py b/skyvern/schemas/steps.py
index 6b8a72b9c..1e51f4e2c 100644
--- a/skyvern/schemas/steps.py
+++ b/skyvern/schemas/steps.py
@@ -7,6 +7,10 @@ from skyvern.webeye.actions.actions import Action
from skyvern.webeye.actions.responses import ActionResult
+class BrowserMetadata(BaseModel):
+ website_url: str | None = None
+
+
class AgentStepOutput(BaseModel):
"""
Output of the agent step, this is recorded in the database.
@@ -17,6 +21,7 @@ class AgentStepOutput(BaseModel):
# Nullable for backwards compatibility, once backfill is done, this won't be nullable anymore
actions_and_results: list[tuple[Action, list[ActionResult]]] | None = None
errors: list[UserDefinedError] = []
+ browser_metadata: BrowserMetadata | None = None
def __repr__(self) -> str:
return f"AgentStepOutput({self.model_dump()})"
diff --git a/skyvern/webeye/actions/models.py b/skyvern/webeye/actions/models.py
index b5900a116..99a40384c 100644
--- a/skyvern/webeye/actions/models.py
+++ b/skyvern/webeye/actions/models.py
@@ -7,7 +7,7 @@ from pydantic import BaseModel, ConfigDict
from skyvern.config import settings
from skyvern.errors.errors import UserDefinedError
-from skyvern.schemas.steps import AgentStepOutput
+from skyvern.schemas.steps import AgentStepOutput, BrowserMetadata
from skyvern.webeye.actions.actions import Action, DecisiveAction
from skyvern.webeye.actions.responses import ActionResult
from skyvern.webeye.scraper.scraped_page import ScrapedPage
@@ -63,8 +63,13 @@ class DetailedAgentStepOutput(BaseModel):
def to_agent_step_output(self) -> AgentStepOutput:
clean_output = self.get_clean_detailed_output()
+ browser_metadata: BrowserMetadata | None = None
+ if clean_output.scraped_page and clean_output.scraped_page.url:
+ browser_metadata = BrowserMetadata(website_url=clean_output.scraped_page.url)
+
return AgentStepOutput(
action_results=clean_output.action_results if clean_output.action_results else [],
actions_and_results=(clean_output.actions_and_results if clean_output.actions_and_results else []),
errors=clean_output.extract_errors(),
+ browser_metadata=browser_metadata,
)