File size: 34,515 Bytes
db4810d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 |
from __future__ import annotations
import asyncio
import json
import logging
import re
import time
from pathlib import Path
from typing import Any, Awaitable, Callable, Dict, Generic, List, Optional, TypeVar
from dotenv import load_dotenv
from langchain_core.language_models.chat_models import BaseChatModel
from langchain_core.messages import (
BaseMessage,
HumanMessage,
SystemMessage,
)
# from lmnr.sdk.decorators import observe
from pydantic import BaseModel, ValidationError
from browser_use.agent.gif import create_history_gif
from browser_use.agent.message_manager.service import MessageManager, MessageManagerSettings
from browser_use.agent.message_manager.utils import convert_input_messages, extract_json_from_model_output, save_conversation
from browser_use.agent.prompts import AgentMessagePrompt, PlannerPrompt, SystemPrompt
from browser_use.agent.views import (
ActionResult,
AgentError,
AgentHistory,
AgentHistoryList,
AgentOutput,
AgentSettings,
AgentState,
AgentStepInfo,
StepMetadata,
ToolCallingMethod,
)
from browser_use.browser.browser import Browser
from browser_use.browser.context import BrowserContext
from browser_use.browser.views import BrowserState, BrowserStateHistory
from browser_use.controller.registry.views import ActionModel
from browser_use.controller.service import Controller
from browser_use.dom.history_tree_processor.service import (
DOMHistoryElement,
HistoryTreeProcessor,
)
from browser_use.telemetry.service import ProductTelemetry
from browser_use.telemetry.views import (
AgentEndTelemetryEvent,
AgentRunTelemetryEvent,
AgentStepTelemetryEvent,
)
from browser_use.utils import time_execution_async, time_execution_sync
load_dotenv()
logger = logging.getLogger(__name__)
def log_response(response: AgentOutput) -> None:
"""Utility function to log the model's response."""
if 'Success' in response.current_state.evaluation_previous_goal:
emoji = 'π'
elif 'Failed' in response.current_state.evaluation_previous_goal:
emoji = 'β '
else:
emoji = 'π€·'
logger.info(f'{emoji} Eval: {response.current_state.evaluation_previous_goal}')
logger.info(f'π§ Memory: {response.current_state.memory}')
logger.info(f'π― Next goal: {response.current_state.next_goal}')
for i, action in enumerate(response.action):
logger.info(f'π οΈ Action {i + 1}/{len(response.action)}: {action.model_dump_json(exclude_unset=True)}')
Context = TypeVar('Context')
class Agent(Generic[Context]):
@time_execution_sync('--init (agent)')
def __init__(
self,
task: str,
llm: BaseChatModel,
# Optional parameters
browser: Browser | None = None,
browser_context: BrowserContext | None = None,
controller: Controller[Context] = Controller(),
# Initial agent run parameters
sensitive_data: Optional[Dict[str, str]] = None,
initial_actions: Optional[List[Dict[str, Dict[str, Any]]]] = None,
# Cloud Callbacks
register_new_step_callback: Callable[['BrowserState', 'AgentOutput', int], Awaitable[None]] | None = None,
register_done_callback: Callable[['AgentHistoryList'], Awaitable[None]] | None = None,
register_external_agent_status_raise_error_callback: Callable[[], Awaitable[bool]] | None = None,
# Agent settings
use_vision: bool = True,
use_vision_for_planner: bool = False,
save_conversation_path: Optional[str] = None,
save_conversation_path_encoding: Optional[str] = 'utf-8',
max_failures: int = 3,
retry_delay: int = 10,
override_system_message: Optional[str] = None,
extend_system_message: Optional[str] = None,
max_input_tokens: int = 128000,
validate_output: bool = False,
message_context: Optional[str] = None,
generate_gif: bool | str = False,
available_file_paths: Optional[list[str]] = None,
include_attributes: list[str] = [
'title',
'type',
'name',
'role',
'aria-label',
'placeholder',
'value',
'alt',
'aria-expanded',
'data-date-format',
],
max_actions_per_step: int = 10,
tool_calling_method: Optional[ToolCallingMethod] = 'auto',
page_extraction_llm: Optional[BaseChatModel] = None,
planner_llm: Optional[BaseChatModel] = None,
planner_interval: int = 1, # Run planner every N steps
# Inject state
injected_agent_state: Optional[AgentState] = None,
#
context: Context | None = None,
):
if page_extraction_llm is None:
page_extraction_llm = llm
# Core components
self.task = task
self.llm = llm
self.controller = controller
self.sensitive_data = sensitive_data
self.settings = AgentSettings(
use_vision=use_vision,
use_vision_for_planner=use_vision_for_planner,
save_conversation_path=save_conversation_path,
save_conversation_path_encoding=save_conversation_path_encoding,
max_failures=max_failures,
retry_delay=retry_delay,
override_system_message=override_system_message,
extend_system_message=extend_system_message,
max_input_tokens=max_input_tokens,
validate_output=validate_output,
message_context=message_context,
generate_gif=generate_gif,
available_file_paths=available_file_paths,
include_attributes=include_attributes,
max_actions_per_step=max_actions_per_step,
tool_calling_method=tool_calling_method,
page_extraction_llm=page_extraction_llm,
planner_llm=planner_llm,
planner_interval=planner_interval,
)
# Initialize state
self.state = injected_agent_state or AgentState()
# Action setup
self._setup_action_models()
self._set_browser_use_version_and_source()
self.initial_actions = self._convert_initial_actions(initial_actions) if initial_actions else None
# Model setup
self._set_model_names()
# for models without tool calling, add available actions to context
self.available_actions = self.controller.registry.get_prompt_description()
self.tool_calling_method = self._set_tool_calling_method()
self.settings.message_context = self._set_message_context()
# Initialize message manager with state
self._message_manager = MessageManager(
task=task,
system_message=SystemPrompt(
action_description=self.available_actions,
max_actions_per_step=self.settings.max_actions_per_step,
override_system_message=override_system_message,
extend_system_message=extend_system_message,
).get_system_message(),
settings=MessageManagerSettings(
max_input_tokens=self.settings.max_input_tokens,
include_attributes=self.settings.include_attributes,
message_context=self.settings.message_context,
sensitive_data=sensitive_data,
available_file_paths=self.settings.available_file_paths,
),
state=self.state.message_manager_state,
)
# Browser setup
self.injected_browser = browser is not None
self.injected_browser_context = browser_context is not None
self.browser = browser if browser is not None else (None if browser_context else Browser())
if browser_context:
self.browser_context = browser_context
elif self.browser:
self.browser_context = BrowserContext(browser=self.browser, config=self.browser.config.new_context_config)
else:
self.browser = Browser()
self.browser_context = BrowserContext(browser=self.browser)
# Callbacks
self.register_new_step_callback = register_new_step_callback
self.register_done_callback = register_done_callback
self.register_external_agent_status_raise_error_callback = register_external_agent_status_raise_error_callback
# Context
self.context = context
# Telemetry
self.telemetry = ProductTelemetry()
if self.settings.save_conversation_path:
logger.info(f'Saving conversation to {self.settings.save_conversation_path}')
def _set_message_context(self) -> str | None:
if self.tool_calling_method == 'raw':
if self.settings.message_context:
self.settings.message_context += f'\n\nAvailable actions: {self.available_actions}'
else:
self.settings.message_context = f'Available actions: {self.available_actions}'
return self.settings.message_context
def _set_browser_use_version_and_source(self) -> None:
"""Get the version and source of the browser-use package (git or pip in a nutshell)"""
try:
# First check for repository-specific files
repo_files = ['.git', 'README.md', 'docs', 'examples']
package_root = Path(__file__).parent.parent.parent
# If all of these files/dirs exist, it's likely from git
if all(Path(package_root / file).exists() for file in repo_files):
try:
import subprocess
version = subprocess.check_output(['git', 'describe', '--tags']).decode('utf-8').strip()
except Exception:
version = 'unknown'
source = 'git'
else:
# If no repo files found, try getting version from pip
import pkg_resources
version = pkg_resources.get_distribution('browser-use').version
source = 'pip'
except Exception:
version = 'unknown'
source = 'unknown'
logger.debug(f'Version: {version}, Source: {source}')
self.version = version
self.source = source
def _set_model_names(self) -> None:
self.chat_model_library = self.llm.__class__.__name__
self.model_name = 'Unknown'
if hasattr(self.llm, 'model_name'):
model = self.llm.model_name # type: ignore
self.model_name = model if model is not None else 'Unknown'
elif hasattr(self.llm, 'model'):
model = self.llm.model # type: ignore
self.model_name = model if model is not None else 'Unknown'
if self.settings.planner_llm:
if hasattr(self.settings.planner_llm, 'model_name'):
self.planner_model_name = self.settings.planner_llm.model_name # type: ignore
elif hasattr(self.settings.planner_llm, 'model'):
self.planner_model_name = self.settings.planner_llm.model # type: ignore
else:
self.planner_model_name = 'Unknown'
else:
self.planner_model_name = None
def _setup_action_models(self) -> None:
"""Setup dynamic action models from controller's registry"""
self.ActionModel = self.controller.registry.create_action_model()
# Create output model with the dynamic actions
self.AgentOutput = AgentOutput.type_with_custom_actions(self.ActionModel)
# used to force the done action when max_steps is reached
self.DoneActionModel = self.controller.registry.create_action_model(include_actions=['done'])
self.DoneAgentOutput = AgentOutput.type_with_custom_actions(self.DoneActionModel)
def _set_tool_calling_method(self) -> Optional[ToolCallingMethod]:
tool_calling_method = self.settings.tool_calling_method
if tool_calling_method == 'auto':
if 'deepseek-reasoner' in self.model_name or 'deepseek-r1' in self.model_name:
return 'raw'
elif self.chat_model_library == 'ChatGoogleGenerativeAI':
return None
elif self.chat_model_library == 'ChatOpenAI':
return 'function_calling'
elif self.chat_model_library == 'AzureChatOpenAI':
return 'function_calling'
else:
return None
else:
return tool_calling_method
def add_new_task(self, new_task: str) -> None:
self._message_manager.add_new_task(new_task)
async def _raise_if_stopped_or_paused(self) -> None:
"""Utility function that raises an InterruptedError if the agent is stopped or paused."""
if self.register_external_agent_status_raise_error_callback:
if await self.register_external_agent_status_raise_error_callback():
raise InterruptedError
if self.state.stopped or self.state.paused:
logger.debug('Agent paused after getting state')
raise InterruptedError
# @observe(name='agent.step', ignore_output=True, ignore_input=True)
@time_execution_async('--step (agent)')
async def step(self, step_info: Optional[AgentStepInfo] = None) -> None:
"""Execute one step of the task"""
logger.info(f'π Step {self.state.n_steps}')
state = None
model_output = None
result: list[ActionResult] = []
step_start_time = time.time()
tokens = 0
try:
state = await self.browser_context.get_state()
await self._raise_if_stopped_or_paused()
self._message_manager.add_state_message(state, self.state.last_result, step_info, self.settings.use_vision)
# Run planner at specified intervals if planner is configured
if self.settings.planner_llm and self.state.n_steps % self.settings.planner_interval == 0:
plan = await self._run_planner()
# add plan before last state message
self._message_manager.add_plan(plan, position=-1)
if step_info and step_info.is_last_step():
# Add last step warning if needed
msg = 'Now comes your last step. Use only the "done" action now. No other actions - so here your action sequence must have length 1.'
msg += '\nIf the task is not yet fully finished as requested by the user, set success in "done" to false! E.g. if not all steps are fully completed.'
msg += '\nIf the task is fully finished, set success in "done" to true.'
msg += '\nInclude everything you found out for the ultimate task in the done text.'
logger.info('Last step finishing up')
self._message_manager._add_message_with_tokens(HumanMessage(content=msg))
self.AgentOutput = self.DoneAgentOutput
input_messages = self._message_manager.get_messages()
tokens = self._message_manager.state.history.current_tokens
try:
model_output = await self.get_next_action(input_messages)
self.state.n_steps += 1
if self.register_new_step_callback:
await self.register_new_step_callback(state, model_output, self.state.n_steps)
if self.settings.save_conversation_path:
target = self.settings.save_conversation_path + f'_{self.state.n_steps}.txt'
save_conversation(input_messages, model_output, target, self.settings.save_conversation_path_encoding)
self._message_manager._remove_last_state_message() # we dont want the whole state in the chat history
await self._raise_if_stopped_or_paused()
self._message_manager.add_model_output(model_output)
except Exception as e:
# model call failed, remove last state message from history
self._message_manager._remove_last_state_message()
raise e
result: list[ActionResult] = await self.multi_act(model_output.action)
self.state.last_result = result
if len(result) > 0 and result[-1].is_done:
logger.info(f'π Result: {result[-1].extracted_content}')
self.state.consecutive_failures = 0
except InterruptedError:
logger.debug('Agent paused')
self.state.last_result = [
ActionResult(
error='The agent was paused - now continuing actions might need to be repeated', include_in_memory=True
)
]
return
except Exception as e:
result = await self._handle_step_error(e)
self.state.last_result = result
finally:
step_end_time = time.time()
actions = [a.model_dump(exclude_unset=True) for a in model_output.action] if model_output else []
self.telemetry.capture(
AgentStepTelemetryEvent(
agent_id=self.state.agent_id,
step=self.state.n_steps,
actions=actions,
consecutive_failures=self.state.consecutive_failures,
step_error=[r.error for r in result if r.error] if result else ['No result'],
)
)
if not result:
return
if state:
metadata = StepMetadata(
step_number=self.state.n_steps,
step_start_time=step_start_time,
step_end_time=step_end_time,
input_tokens=tokens,
)
self._make_history_item(model_output, state, result, metadata)
@time_execution_async('--handle_step_error (agent)')
async def _handle_step_error(self, error: Exception) -> list[ActionResult]:
"""Handle all types of errors that can occur during a step"""
include_trace = logger.isEnabledFor(logging.DEBUG)
error_msg = AgentError.format_error(error, include_trace=include_trace)
prefix = f'β Result failed {self.state.consecutive_failures + 1}/{self.settings.max_failures} times:\n '
if isinstance(error, (ValidationError, ValueError)):
logger.error(f'{prefix}{error_msg}')
if 'Max token limit reached' in error_msg:
# cut tokens from history
self._message_manager.settings.max_input_tokens = self.settings.max_input_tokens - 500
logger.info(
f'Cutting tokens from history - new max input tokens: {self._message_manager.settings.max_input_tokens}'
)
self._message_manager.cut_messages()
elif 'Could not parse response' in error_msg:
# give model a hint how output should look like
error_msg += '\n\nReturn a valid JSON object with the required fields.'
self.state.consecutive_failures += 1
else:
from google.api_core.exceptions import ResourceExhausted
from openai import RateLimitError
if isinstance(error, RateLimitError) or isinstance(error, ResourceExhausted):
logger.warning(f'{prefix}{error_msg}')
await asyncio.sleep(self.settings.retry_delay)
self.state.consecutive_failures += 1
else:
logger.error(f'{prefix}{error_msg}')
self.state.consecutive_failures += 1
return [ActionResult(error=error_msg, include_in_memory=True)]
def _make_history_item(
self,
model_output: AgentOutput | None,
state: BrowserState,
result: list[ActionResult],
metadata: Optional[StepMetadata] = None,
) -> None:
"""Create and store history item"""
if model_output:
interacted_elements = AgentHistory.get_interacted_element(model_output, state.selector_map)
else:
interacted_elements = [None]
state_history = BrowserStateHistory(
url=state.url,
title=state.title,
tabs=state.tabs,
interacted_element=interacted_elements,
screenshot=state.screenshot,
)
history_item = AgentHistory(model_output=model_output, result=result, state=state_history, metadata=metadata)
self.state.history.history.append(history_item)
THINK_TAGS = re.compile(r'<think>.*?</think>', re.DOTALL)
STRAY_CLOSE_TAG = re.compile(r'.*?</think>', re.DOTALL)
def _remove_think_tags(self, text: str) -> str:
# Step 1: Remove well-formed <think>...</think>
text = re.sub(self.THINK_TAGS, '', text)
# Step 2: If there's an unmatched closing tag </think>,
# remove everything up to and including that.
text = re.sub(self.STRAY_CLOSE_TAG, '', text)
return text.strip()
def _convert_input_messages(self, input_messages: list[BaseMessage]) -> list[BaseMessage]:
"""Convert input messages to the correct format"""
if self.model_name == 'deepseek-reasoner' or 'deepseek-r1' in self.model_name:
return convert_input_messages(input_messages, self.model_name)
else:
return input_messages
@time_execution_async('--get_next_action (agent)')
async def get_next_action(self, input_messages: list[BaseMessage]) -> AgentOutput:
"""Get next action from LLM based on current state"""
input_messages = self._convert_input_messages(input_messages)
if self.tool_calling_method == 'raw':
output = self.llm.invoke(input_messages)
# TODO: currently invoke does not return reasoning_content, we should override invoke
output.content = self._remove_think_tags(str(output.content))
try:
parsed_json = extract_json_from_model_output(output.content)
parsed = self.AgentOutput(**parsed_json)
except (ValueError, ValidationError) as e:
logger.warning(f'Failed to parse model output: {output} {str(e)}')
raise ValueError('Could not parse response.')
elif self.tool_calling_method is None:
structured_llm = self.llm.with_structured_output(self.AgentOutput, include_raw=True)
response: dict[str, Any] = await structured_llm.ainvoke(input_messages) # type: ignore
parsed: AgentOutput | None = response['parsed']
else:
structured_llm = self.llm.with_structured_output(self.AgentOutput, include_raw=True, method=self.tool_calling_method)
response: dict[str, Any] = await structured_llm.ainvoke(input_messages) # type: ignore
parsed: AgentOutput | None = response['parsed']
if parsed is None:
raise ValueError('Could not parse response.')
# cut the number of actions to max_actions_per_step if needed
if len(parsed.action) > self.settings.max_actions_per_step:
parsed.action = parsed.action[: self.settings.max_actions_per_step]
log_response(parsed)
return parsed
def _log_agent_run(self) -> None:
"""Log the agent run"""
logger.info(f'π Starting task: {self.task}')
logger.debug(f'Version: {self.version}, Source: {self.source}')
self.telemetry.capture(
AgentRunTelemetryEvent(
agent_id=self.state.agent_id,
use_vision=self.settings.use_vision,
task=self.task,
model_name=self.model_name,
chat_model_library=self.chat_model_library,
version=self.version,
source=self.source,
)
)
async def take_step(self) -> tuple[bool, bool]:
"""Take a step
Returns:
Tuple[bool, bool]: (is_done, is_valid)
"""
await self.step()
if self.state.history.is_done():
if self.settings.validate_output:
if not await self._validate_output():
return True, False
await self.log_completion()
if self.register_done_callback:
await self.register_done_callback(self.state.history)
return True, True
return False, False
# @observe(name='agent.run', ignore_output=True)
@time_execution_async('--run (agent)')
async def run(self, max_steps: int = 100) -> AgentHistoryList:
"""Execute the task with maximum number of steps"""
try:
self._log_agent_run()
# Execute initial actions if provided
if self.initial_actions:
result = await self.multi_act(self.initial_actions, check_for_new_elements=False)
self.state.last_result = result
for step in range(max_steps):
# Check if we should stop due to too many failures
if self.state.consecutive_failures >= self.settings.max_failures:
logger.error(f'β Stopping due to {self.settings.max_failures} consecutive failures')
break
# Check control flags before each step
if self.state.stopped:
logger.info('Agent stopped')
break
while self.state.paused:
await asyncio.sleep(0.2) # Small delay to prevent CPU spinning
if self.state.stopped: # Allow stopping while paused
break
step_info = AgentStepInfo(step_number=step, max_steps=max_steps)
await self.step(step_info)
if self.state.history.is_done():
if self.settings.validate_output and step < max_steps - 1:
if not await self._validate_output():
continue
await self.log_completion()
break
else:
logger.info('β Failed to complete task in maximum steps')
return self.state.history
finally:
self.telemetry.capture(
AgentEndTelemetryEvent(
agent_id=self.state.agent_id,
is_done=self.state.history.is_done(),
success=self.state.history.is_successful(),
steps=self.state.n_steps,
max_steps_reached=self.state.n_steps >= max_steps,
errors=self.state.history.errors(),
total_input_tokens=self.state.history.total_input_tokens(),
total_duration_seconds=self.state.history.total_duration_seconds(),
)
)
if not self.injected_browser_context:
await self.browser_context.close()
if not self.injected_browser and self.browser:
await self.browser.close()
if self.settings.generate_gif:
output_path: str = 'agent_history.gif'
if isinstance(self.settings.generate_gif, str):
output_path = self.settings.generate_gif
create_history_gif(task=self.task, history=self.state.history, output_path=output_path)
# @observe(name='controller.multi_act')
@time_execution_async('--multi-act (agent)')
async def multi_act(
self,
actions: list[ActionModel],
check_for_new_elements: bool = True,
) -> list[ActionResult]:
"""Execute multiple actions"""
results = []
cached_selector_map = await self.browser_context.get_selector_map()
cached_path_hashes = set(e.hash.branch_path_hash for e in cached_selector_map.values())
await self.browser_context.remove_highlights()
for i, action in enumerate(actions):
if action.get_index() is not None and i != 0:
new_state = await self.browser_context.get_state()
new_path_hashes = set(e.hash.branch_path_hash for e in new_state.selector_map.values())
if check_for_new_elements and not new_path_hashes.issubset(cached_path_hashes):
# next action requires index but there are new elements on the page
msg = f'Something new appeared after action {i} / {len(actions)}'
logger.info(msg)
results.append(ActionResult(extracted_content=msg, include_in_memory=True))
break
await self._raise_if_stopped_or_paused()
result = await self.controller.act(
action,
self.browser_context,
self.settings.page_extraction_llm,
self.sensitive_data,
self.settings.available_file_paths,
context=self.context,
)
results.append(result)
logger.debug(f'Executed action {i + 1} / {len(actions)}')
if results[-1].is_done or results[-1].error or i == len(actions) - 1:
break
await asyncio.sleep(self.browser_context.config.wait_between_actions)
# hash all elements. if it is a subset of cached_state its fine - else break (new elements on page)
return results
async def _validate_output(self) -> bool:
"""Validate the output of the last action is what the user wanted"""
system_msg = (
f'You are a validator of an agent who interacts with a browser. '
f'Validate if the output of last action is what the user wanted and if the task is completed. '
f'If the task is unclear defined, you can let it pass. But if something is missing or the image does not show what was requested dont let it pass. '
f'Try to understand the page and help the model with suggestions like scroll, do x, ... to get the solution right. '
f'Task to validate: {self.task}. Return a JSON object with 2 keys: is_valid and reason. '
f'is_valid is a boolean that indicates if the output is correct. '
f'reason is a string that explains why it is valid or not.'
f' example: {{"is_valid": false, "reason": "The user wanted to search for "cat photos", but the agent searched for "dog photos" instead."}}'
)
if self.browser_context.session:
state = await self.browser_context.get_state()
content = AgentMessagePrompt(
state=state,
result=self.state.last_result,
include_attributes=self.settings.include_attributes,
)
msg = [SystemMessage(content=system_msg), content.get_user_message(self.settings.use_vision)]
else:
# if no browser session, we can't validate the output
return True
class ValidationResult(BaseModel):
"""
Validation results.
"""
is_valid: bool
reason: str
validator = self.llm.with_structured_output(ValidationResult, include_raw=True)
response: dict[str, Any] = await validator.ainvoke(msg) # type: ignore
parsed: ValidationResult = response['parsed']
is_valid = parsed.is_valid
if not is_valid:
logger.info(f'β Validator decision: {parsed.reason}')
msg = f'The output is not yet correct. {parsed.reason}.'
self.state.last_result = [ActionResult(extracted_content=msg, include_in_memory=True)]
else:
logger.info(f'β
Validator decision: {parsed.reason}')
return is_valid
async def log_completion(self) -> None:
"""Log the completion of the task"""
logger.info('β
Task completed')
if self.state.history.is_successful():
logger.info('β
Successfully')
else:
logger.info('β Unfinished')
if self.register_done_callback:
await self.register_done_callback(self.state.history)
async def rerun_history(
self,
history: AgentHistoryList,
max_retries: int = 3,
skip_failures: bool = True,
delay_between_actions: float = 2.0,
) -> list[ActionResult]:
"""
Rerun a saved history of actions with error handling and retry logic.
Args:
history: The history to replay
max_retries: Maximum number of retries per action
skip_failures: Whether to skip failed actions or stop execution
delay_between_actions: Delay between actions in seconds
Returns:
List of action results
"""
# Execute initial actions if provided
if self.initial_actions:
result = await self.multi_act(self.initial_actions)
self.state.last_result = result
results = []
for i, history_item in enumerate(history.history):
goal = history_item.model_output.current_state.next_goal if history_item.model_output else ''
logger.info(f'Replaying step {i + 1}/{len(history.history)}: goal: {goal}')
if (
not history_item.model_output
or not history_item.model_output.action
or history_item.model_output.action == [None]
):
logger.warning(f'Step {i + 1}: No action to replay, skipping')
results.append(ActionResult(error='No action to replay'))
continue
retry_count = 0
while retry_count < max_retries:
try:
result = await self._execute_history_step(history_item, delay_between_actions)
results.extend(result)
break
except Exception as e:
retry_count += 1
if retry_count == max_retries:
error_msg = f'Step {i + 1} failed after {max_retries} attempts: {str(e)}'
logger.error(error_msg)
if not skip_failures:
results.append(ActionResult(error=error_msg))
raise RuntimeError(error_msg)
else:
logger.warning(f'Step {i + 1} failed (attempt {retry_count}/{max_retries}), retrying...')
await asyncio.sleep(delay_between_actions)
return results
async def _execute_history_step(self, history_item: AgentHistory, delay: float) -> list[ActionResult]:
"""Execute a single step from history with element validation"""
state = await self.browser_context.get_state()
if not state or not history_item.model_output:
raise ValueError('Invalid state or model output')
updated_actions = []
for i, action in enumerate(history_item.model_output.action):
updated_action = await self._update_action_indices(
history_item.state.interacted_element[i],
action,
state,
)
updated_actions.append(updated_action)
if updated_action is None:
raise ValueError(f'Could not find matching element {i} in current page')
result = await self.multi_act(updated_actions)
await asyncio.sleep(delay)
return result
async def _update_action_indices(
self,
historical_element: Optional[DOMHistoryElement],
action: ActionModel, # Type this properly based on your action model
current_state: BrowserState,
) -> Optional[ActionModel]:
"""
Update action indices based on current page state.
Returns updated action or None if element cannot be found.
"""
if not historical_element or not current_state.element_tree:
return action
current_element = HistoryTreeProcessor.find_history_element_in_tree(historical_element, current_state.element_tree)
if not current_element or current_element.highlight_index is None:
return None
old_index = action.get_index()
if old_index != current_element.highlight_index:
action.set_index(current_element.highlight_index)
logger.info(f'Element moved in DOM, updated index from {old_index} to {current_element.highlight_index}')
return action
async def load_and_rerun(self, history_file: Optional[str | Path] = None, **kwargs) -> list[ActionResult]:
"""
Load history from file and rerun it.
Args:
history_file: Path to the history file
**kwargs: Additional arguments passed to rerun_history
"""
if not history_file:
history_file = 'AgentHistory.json'
history = AgentHistoryList.load_from_file(history_file, self.AgentOutput)
return await self.rerun_history(history, **kwargs)
def save_history(self, file_path: Optional[str | Path] = None) -> None:
"""Save the history to a file"""
if not file_path:
file_path = 'AgentHistory.json'
self.state.history.save_to_file(file_path)
def pause(self) -> None:
"""Pause the agent before the next step"""
logger.info('π pausing Agent ')
self.state.paused = True
def resume(self) -> None:
"""Resume the agent"""
logger.info('βΆοΈ Agent resuming')
self.state.paused = False
def stop(self) -> None:
"""Stop the agent"""
logger.info('βΉοΈ Agent stopping')
self.state.stopped = True
def _convert_initial_actions(self, actions: List[Dict[str, Dict[str, Any]]]) -> List[ActionModel]:
"""Convert dictionary-based actions to ActionModel instances"""
converted_actions = []
action_model = self.ActionModel
for action_dict in actions:
# Each action_dict should have a single key-value pair
action_name = next(iter(action_dict))
params = action_dict[action_name]
# Get the parameter model for this action from registry
action_info = self.controller.registry.registry.actions[action_name]
param_model = action_info.param_model
# Create validated parameters using the appropriate param model
validated_params = param_model(**params)
# Create ActionModel instance with the validated parameters
action_model = self.ActionModel(**{action_name: validated_params})
converted_actions.append(action_model)
return converted_actions
async def _run_planner(self) -> Optional[str]:
"""Run the planner to analyze state and suggest next steps"""
# Skip planning if no planner_llm is set
if not self.settings.planner_llm:
return None
# Create planner message history using full message history
planner_messages = [
PlannerPrompt(self.controller.registry.get_prompt_description()).get_system_message(),
*self._message_manager.get_messages()[1:], # Use full message history except the first
]
if not self.settings.use_vision_for_planner and self.settings.use_vision:
last_state_message: HumanMessage = planner_messages[-1]
# remove image from last state message
new_msg = ''
if isinstance(last_state_message.content, list):
for msg in last_state_message.content:
if msg['type'] == 'text': # type: ignore
new_msg += msg['text'] # type: ignore
elif msg['type'] == 'image_url': # type: ignore
continue # type: ignore
else:
new_msg = last_state_message.content
planner_messages[-1] = HumanMessage(content=new_msg)
planner_messages = convert_input_messages(planner_messages, self.planner_model_name)
# Get planner output
response = await self.settings.planner_llm.ainvoke(planner_messages)
plan = str(response.content)
# if deepseek-reasoner, remove think tags
if self.planner_model_name and ('deepseek-r1' in self.planner_model_name or 'deepseek-reasoner' in self.planner_model_name):
plan = self._remove_think_tags(plan)
try:
plan_json = json.loads(plan)
logger.info(f'Planning Analysis:\n{json.dumps(plan_json, indent=4)}')
except json.JSONDecodeError:
logger.info(f'Planning Analysis:\n{plan}')
except Exception as e:
logger.debug(f'Error parsing planning analysis: {e}')
logger.info(f'Plan: {plan}')
return plan
@property
def message_manager(self) -> MessageManager:
return self._message_manager
|