agent_controller.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922
  1. import asyncio
  2. import copy
  3. import os
  4. import traceback
  5. from typing import Callable, ClassVar, Type
  6. import litellm
  7. from litellm.exceptions import ContextWindowExceededError
  8. from openhands.controller.agent import Agent
  9. from openhands.controller.state.state import State, TrafficControlState
  10. from openhands.controller.stuck import StuckDetector
  11. from openhands.core.config import AgentConfig, LLMConfig
  12. from openhands.core.exceptions import (
  13. FunctionCallNotExistsError,
  14. FunctionCallValidationError,
  15. LLMMalformedActionError,
  16. LLMNoActionError,
  17. LLMResponseError,
  18. )
  19. from openhands.core.logger import LOG_ALL_EVENTS
  20. from openhands.core.logger import openhands_logger as logger
  21. from openhands.core.schema import AgentState
  22. from openhands.events import EventSource, EventStream, EventStreamSubscriber
  23. from openhands.events.action import (
  24. Action,
  25. ActionConfirmationStatus,
  26. AddTaskAction,
  27. AgentDelegateAction,
  28. AgentFinishAction,
  29. AgentRejectAction,
  30. ChangeAgentStateAction,
  31. CmdRunAction,
  32. IPythonRunCellAction,
  33. MessageAction,
  34. ModifyTaskAction,
  35. NullAction,
  36. )
  37. from openhands.events.event import Event
  38. from openhands.events.observation import (
  39. AgentDelegateObservation,
  40. AgentStateChangedObservation,
  41. ErrorObservation,
  42. NullObservation,
  43. Observation,
  44. )
  45. from openhands.events.serialization.event import truncate_content
  46. from openhands.llm.llm import LLM
  47. from openhands.utils.shutdown_listener import should_continue
  48. # note: RESUME is only available on web GUI
  49. TRAFFIC_CONTROL_REMINDER = (
  50. "Please click on resume button if you'd like to continue, or start a new task."
  51. )
  52. class AgentController:
  53. id: str
  54. agent: Agent
  55. max_iterations: int
  56. event_stream: EventStream
  57. state: State
  58. confirmation_mode: bool
  59. agent_to_llm_config: dict[str, LLMConfig]
  60. agent_configs: dict[str, AgentConfig]
  61. agent_task: asyncio.Future | None = None
  62. parent: 'AgentController | None' = None
  63. delegate: 'AgentController | None' = None
  64. _pending_action: Action | None = None
  65. _closed: bool = False
  66. filter_out: ClassVar[tuple[type[Event], ...]] = (
  67. NullAction,
  68. NullObservation,
  69. ChangeAgentStateAction,
  70. AgentStateChangedObservation,
  71. )
  72. def __init__(
  73. self,
  74. agent: Agent,
  75. event_stream: EventStream,
  76. max_iterations: int,
  77. max_budget_per_task: float | None = None,
  78. agent_to_llm_config: dict[str, LLMConfig] | None = None,
  79. agent_configs: dict[str, AgentConfig] | None = None,
  80. sid: str = 'default',
  81. confirmation_mode: bool = False,
  82. initial_state: State | None = None,
  83. is_delegate: bool = False,
  84. headless_mode: bool = True,
  85. status_callback: Callable | None = None,
  86. ):
  87. """Initializes a new instance of the AgentController class.
  88. Args:
  89. agent: The agent instance to control.
  90. event_stream: The event stream to publish events to.
  91. max_iterations: The maximum number of iterations the agent can run.
  92. max_budget_per_task: The maximum budget (in USD) allowed per task, beyond which the agent will stop.
  93. agent_to_llm_config: A dictionary mapping agent names to LLM configurations in the case that
  94. we delegate to a different agent.
  95. agent_configs: A dictionary mapping agent names to agent configurations in the case that
  96. we delegate to a different agent.
  97. sid: The session ID of the agent.
  98. confirmation_mode: Whether to enable confirmation mode for agent actions.
  99. initial_state: The initial state of the controller.
  100. is_delegate: Whether this controller is a delegate.
  101. headless_mode: Whether the agent is run in headless mode.
  102. status_callback: Optional callback function to handle status updates.
  103. """
  104. self._step_lock = asyncio.Lock()
  105. self.id = sid
  106. self.agent = agent
  107. self.headless_mode = headless_mode
  108. # subscribe to the event stream
  109. self.event_stream = event_stream
  110. self.event_stream.subscribe(
  111. EventStreamSubscriber.AGENT_CONTROLLER, self.on_event, self.id
  112. )
  113. # state from the previous session, state from a parent agent, or a fresh state
  114. self.set_initial_state(
  115. state=initial_state,
  116. max_iterations=max_iterations,
  117. confirmation_mode=confirmation_mode,
  118. )
  119. self.max_budget_per_task = max_budget_per_task
  120. self.agent_to_llm_config = agent_to_llm_config if agent_to_llm_config else {}
  121. self.agent_configs = agent_configs if agent_configs else {}
  122. self._initial_max_iterations = max_iterations
  123. self._initial_max_budget_per_task = max_budget_per_task
  124. # stuck helper
  125. self._stuck_detector = StuckDetector(self.state)
  126. self.status_callback = status_callback
  127. async def close(self) -> None:
  128. """Closes the agent controller, canceling any ongoing tasks and unsubscribing from the event stream.
  129. Note that it's fairly important that this closes properly, otherwise the state is incomplete.
  130. """
  131. await self.set_agent_state_to(AgentState.STOPPED)
  132. # we made history, now is the time to rewrite it!
  133. # the final state.history will be used by external scripts like evals, tests, etc.
  134. # history will need to be complete WITH delegates events
  135. # like the regular agent history, it does not include:
  136. # - 'hidden' events, events with hidden=True
  137. # - backend events (the default 'filtered out' types, types in self.filter_out)
  138. start_id = self.state.start_id if self.state.start_id >= 0 else 0
  139. end_id = (
  140. self.state.end_id
  141. if self.state.end_id >= 0
  142. else self.event_stream.get_latest_event_id()
  143. )
  144. self.state.history = list(
  145. self.event_stream.get_events(
  146. start_id=start_id,
  147. end_id=end_id,
  148. reverse=False,
  149. filter_out_type=self.filter_out,
  150. filter_hidden=True,
  151. )
  152. )
  153. # unsubscribe from the event stream
  154. self.event_stream.unsubscribe(EventStreamSubscriber.AGENT_CONTROLLER, self.id)
  155. self._closed = True
  156. def log(self, level: str, message: str, extra: dict | None = None) -> None:
  157. """Logs a message to the agent controller's logger.
  158. Args:
  159. level (str): The logging level to use (e.g., 'info', 'debug', 'error').
  160. message (str): The message to log.
  161. extra (dict | None, optional): Additional fields to include in the log. Defaults to None.
  162. """
  163. message = f'[Agent Controller {self.id}] {message}'
  164. getattr(logger, level)(message, extra=extra, stacklevel=2)
  165. def update_state_before_step(self):
  166. self.state.iteration += 1
  167. self.state.local_iteration += 1
  168. async def update_state_after_step(self):
  169. # update metrics especially for cost. Use deepcopy to avoid it being modified by agent._reset()
  170. self.state.local_metrics = copy.deepcopy(self.agent.llm.metrics)
  171. async def _react_to_exception(
  172. self,
  173. e: Exception,
  174. ):
  175. await self.set_agent_state_to(AgentState.ERROR)
  176. if self.status_callback is not None:
  177. err_id = ''
  178. if isinstance(e, litellm.AuthenticationError):
  179. err_id = 'STATUS$ERROR_LLM_AUTHENTICATION'
  180. self.status_callback('error', err_id, str(e))
  181. async def start_step_loop(self):
  182. """The main loop for the agent's step-by-step execution."""
  183. self.log('info', 'Starting step loop...')
  184. while True:
  185. if not self._is_awaiting_observation() and not should_continue():
  186. break
  187. if self._closed:
  188. break
  189. try:
  190. await self._step()
  191. except asyncio.CancelledError:
  192. self.log('debug', 'AgentController task was cancelled')
  193. break
  194. except Exception as e:
  195. traceback.print_exc()
  196. self.log('error', f'Error while running the agent: {e}')
  197. await self._react_to_exception(e)
  198. await asyncio.sleep(0.1)
  199. async def on_event(self, event: Event) -> None:
  200. """Callback from the event stream. Notifies the controller of incoming events.
  201. Args:
  202. event (Event): The incoming event to process.
  203. """
  204. if hasattr(event, 'hidden') and event.hidden:
  205. return
  206. # if the event is not filtered out, add it to the history
  207. if not any(isinstance(event, filter_type) for filter_type in self.filter_out):
  208. self.state.history.append(event)
  209. if isinstance(event, Action):
  210. await self._handle_action(event)
  211. elif isinstance(event, Observation):
  212. await self._handle_observation(event)
  213. async def _handle_action(self, action: Action) -> None:
  214. """Handles actions from the event stream.
  215. Args:
  216. action (Action): The action to handle.
  217. """
  218. if isinstance(action, ChangeAgentStateAction):
  219. await self.set_agent_state_to(action.agent_state) # type: ignore
  220. elif isinstance(action, MessageAction):
  221. await self._handle_message_action(action)
  222. elif isinstance(action, AgentDelegateAction):
  223. await self.start_delegate(action)
  224. elif isinstance(action, AddTaskAction):
  225. self.state.root_task.add_subtask(
  226. action.parent, action.goal, action.subtasks
  227. )
  228. elif isinstance(action, ModifyTaskAction):
  229. self.state.root_task.set_subtask_state(action.task_id, action.state)
  230. elif isinstance(action, AgentFinishAction):
  231. self.state.outputs = action.outputs
  232. self.state.metrics.merge(self.state.local_metrics)
  233. await self.set_agent_state_to(AgentState.FINISHED)
  234. elif isinstance(action, AgentRejectAction):
  235. self.state.outputs = action.outputs
  236. self.state.metrics.merge(self.state.local_metrics)
  237. await self.set_agent_state_to(AgentState.REJECTED)
  238. async def _handle_observation(self, observation: Observation) -> None:
  239. """Handles observation from the event stream.
  240. Args:
  241. observation (observation): The observation to handle.
  242. """
  243. observation_to_print = copy.deepcopy(observation)
  244. if len(observation_to_print.content) > self.agent.llm.config.max_message_chars:
  245. observation_to_print.content = truncate_content(
  246. observation_to_print.content, self.agent.llm.config.max_message_chars
  247. )
  248. # Use info level if LOG_ALL_EVENTS is set
  249. log_level = 'info' if os.getenv('LOG_ALL_EVENTS') in ('true', '1') else 'debug'
  250. self.log(
  251. log_level, str(observation_to_print), extra={'msg_type': 'OBSERVATION'}
  252. )
  253. if observation.llm_metrics is not None:
  254. self.agent.llm.metrics.merge(observation.llm_metrics)
  255. if self._pending_action and self._pending_action.id == observation.cause:
  256. if self.state.agent_state == AgentState.AWAITING_USER_CONFIRMATION:
  257. return
  258. self._pending_action = None
  259. if self.state.agent_state == AgentState.USER_CONFIRMED:
  260. await self.set_agent_state_to(AgentState.RUNNING)
  261. if self.state.agent_state == AgentState.USER_REJECTED:
  262. await self.set_agent_state_to(AgentState.AWAITING_USER_INPUT)
  263. return
  264. elif isinstance(observation, ErrorObservation):
  265. if self.state.agent_state == AgentState.ERROR:
  266. self.state.metrics.merge(self.state.local_metrics)
  267. async def _handle_message_action(self, action: MessageAction) -> None:
  268. """Handles message actions from the event stream.
  269. Args:
  270. action (MessageAction): The message action to handle.
  271. """
  272. if action.source == EventSource.USER:
  273. # Use info level if LOG_ALL_EVENTS is set
  274. log_level = (
  275. 'info' if os.getenv('LOG_ALL_EVENTS') in ('true', '1') else 'debug'
  276. )
  277. self.log(
  278. log_level,
  279. str(action),
  280. extra={'msg_type': 'ACTION', 'event_source': EventSource.USER},
  281. )
  282. if self.get_agent_state() != AgentState.RUNNING:
  283. await self.set_agent_state_to(AgentState.RUNNING)
  284. elif action.source == EventSource.AGENT and action.wait_for_response:
  285. await self.set_agent_state_to(AgentState.AWAITING_USER_INPUT)
  286. def _reset(self) -> None:
  287. """Resets the agent controller"""
  288. self.almost_stuck = 0
  289. self._pending_action = None
  290. self.agent.reset()
  291. async def set_agent_state_to(self, new_state: AgentState) -> None:
  292. """Updates the agent's state and handles side effects. Can emit events to the event stream.
  293. Args:
  294. new_state (AgentState): The new state to set for the agent.
  295. """
  296. self.log(
  297. 'info',
  298. f'Setting agent({self.agent.name}) state from {self.state.agent_state} to {new_state}',
  299. )
  300. if new_state == self.state.agent_state:
  301. return
  302. if new_state in (AgentState.STOPPED, AgentState.ERROR):
  303. self._reset()
  304. elif (
  305. new_state == AgentState.RUNNING
  306. and self.state.agent_state == AgentState.PAUSED
  307. and self.state.traffic_control_state == TrafficControlState.THROTTLING
  308. ):
  309. # user intends to interrupt traffic control and let the task resume temporarily
  310. self.state.traffic_control_state = TrafficControlState.PAUSED
  311. # User has chosen to deliberately continue - lets double the max iterations
  312. if (
  313. self.state.iteration is not None
  314. and self.state.max_iterations is not None
  315. and self._initial_max_iterations is not None
  316. ):
  317. if self.state.iteration >= self.state.max_iterations:
  318. self.state.max_iterations += self._initial_max_iterations
  319. if (
  320. self.state.metrics.accumulated_cost is not None
  321. and self.max_budget_per_task is not None
  322. and self._initial_max_budget_per_task is not None
  323. ):
  324. if self.state.metrics.accumulated_cost >= self.max_budget_per_task:
  325. self.max_budget_per_task += self._initial_max_budget_per_task
  326. elif self._pending_action is not None and (
  327. new_state in (AgentState.USER_CONFIRMED, AgentState.USER_REJECTED)
  328. ):
  329. if hasattr(self._pending_action, 'thought'):
  330. self._pending_action.thought = '' # type: ignore[union-attr]
  331. if new_state == AgentState.USER_CONFIRMED:
  332. confirmation_state = ActionConfirmationStatus.CONFIRMED
  333. else:
  334. confirmation_state = ActionConfirmationStatus.REJECTED
  335. self._pending_action.confirmation_state = confirmation_state # type: ignore[attr-defined]
  336. self._pending_action._id = None # type: ignore[attr-defined]
  337. self.event_stream.add_event(self._pending_action, EventSource.AGENT)
  338. self.state.agent_state = new_state
  339. self.event_stream.add_event(
  340. AgentStateChangedObservation('', self.state.agent_state),
  341. EventSource.ENVIRONMENT,
  342. )
  343. if new_state == AgentState.INIT and self.state.resume_state:
  344. await self.set_agent_state_to(self.state.resume_state)
  345. self.state.resume_state = None
  346. def get_agent_state(self) -> AgentState:
  347. """Returns the current state of the agent.
  348. Returns:
  349. AgentState: The current state of the agent.
  350. """
  351. return self.state.agent_state
  352. async def start_delegate(self, action: AgentDelegateAction) -> None:
  353. """Start a delegate agent to handle a subtask.
  354. OpenHands is a multi-agentic system. A `task` is a conversation between
  355. OpenHands (the whole system) and the user, which might involve one or more inputs
  356. from the user. It starts with an initial input (typically a task statement) from
  357. the user, and ends with either an `AgentFinishAction` initiated by the agent, a
  358. stop initiated by the user, or an error.
  359. A `subtask` is a conversation between an agent and the user, or another agent. If a `task`
  360. is conducted by a single agent, then it's also a `subtask`. Otherwise, a `task` consists of
  361. multiple `subtasks`, each executed by one agent.
  362. Args:
  363. action (AgentDelegateAction): The action containing information about the delegate agent to start.
  364. """
  365. agent_cls: Type[Agent] = Agent.get_cls(action.agent)
  366. agent_config = self.agent_configs.get(action.agent, self.agent.config)
  367. llm_config = self.agent_to_llm_config.get(action.agent, self.agent.llm.config)
  368. llm = LLM(config=llm_config)
  369. delegate_agent = agent_cls(llm=llm, config=agent_config)
  370. state = State(
  371. inputs=action.inputs or {},
  372. local_iteration=0,
  373. iteration=self.state.iteration,
  374. max_iterations=self.state.max_iterations,
  375. delegate_level=self.state.delegate_level + 1,
  376. # global metrics should be shared between parent and child
  377. metrics=self.state.metrics,
  378. # start on top of the stream
  379. start_id=self.event_stream.get_latest_event_id() + 1,
  380. )
  381. self.log(
  382. 'debug',
  383. f'start delegate, creating agent {delegate_agent.name} using LLM {llm}',
  384. )
  385. self.event_stream.unsubscribe(EventStreamSubscriber.AGENT_CONTROLLER, self.id)
  386. self.delegate = AgentController(
  387. sid=self.id + '-delegate',
  388. agent=delegate_agent,
  389. event_stream=self.event_stream,
  390. max_iterations=self.state.max_iterations,
  391. max_budget_per_task=self.max_budget_per_task,
  392. agent_to_llm_config=self.agent_to_llm_config,
  393. agent_configs=self.agent_configs,
  394. initial_state=state,
  395. is_delegate=True,
  396. headless_mode=self.headless_mode,
  397. )
  398. await self.delegate.set_agent_state_to(AgentState.RUNNING)
  399. async def _step(self) -> None:
  400. """Executes a single step of the parent or delegate agent. Detects stuck agents and limits on the number of iterations and the task budget."""
  401. if self.get_agent_state() != AgentState.RUNNING:
  402. await asyncio.sleep(1)
  403. return
  404. if self._pending_action:
  405. await asyncio.sleep(1)
  406. return
  407. if self.delegate is not None:
  408. assert self.delegate != self
  409. if self.delegate.get_agent_state() == AgentState.PAUSED:
  410. # no need to check too often
  411. await asyncio.sleep(1)
  412. else:
  413. await self._delegate_step()
  414. return
  415. self.log(
  416. 'info',
  417. f'LEVEL {self.state.delegate_level} LOCAL STEP {self.state.local_iteration} GLOBAL STEP {self.state.iteration}',
  418. extra={'msg_type': 'STEP'},
  419. )
  420. # check if agent hit the resources limit
  421. stop_step = False
  422. if self.state.iteration >= self.state.max_iterations:
  423. stop_step = await self._handle_traffic_control(
  424. 'iteration', self.state.iteration, self.state.max_iterations
  425. )
  426. if self.max_budget_per_task is not None:
  427. current_cost = self.state.metrics.accumulated_cost
  428. if current_cost > self.max_budget_per_task:
  429. stop_step = await self._handle_traffic_control(
  430. 'budget', current_cost, self.max_budget_per_task
  431. )
  432. if stop_step:
  433. return
  434. if self._is_stuck():
  435. await self._react_to_exception(RuntimeError('Agent got stuck in a loop'))
  436. return
  437. self.update_state_before_step()
  438. action: Action = NullAction()
  439. try:
  440. action = self.agent.step(self.state)
  441. if action is None:
  442. raise LLMNoActionError('No action was returned')
  443. except (
  444. LLMMalformedActionError,
  445. LLMNoActionError,
  446. LLMResponseError,
  447. FunctionCallValidationError,
  448. FunctionCallNotExistsError,
  449. ) as e:
  450. self.event_stream.add_event(
  451. ErrorObservation(
  452. content=str(e),
  453. ),
  454. EventSource.AGENT,
  455. )
  456. return
  457. except ContextWindowExceededError:
  458. # When context window is exceeded, keep roughly half of agent interactions
  459. self.state.history = self._apply_conversation_window(self.state.history)
  460. # Save the ID of the first event in our truncated history for future reloading
  461. if self.state.history:
  462. self.state.start_id = self.state.history[0].id
  463. # Don't add error event - let the agent retry with reduced context
  464. return
  465. if action.runnable:
  466. if self.state.confirmation_mode and (
  467. type(action) is CmdRunAction or type(action) is IPythonRunCellAction
  468. ):
  469. action.confirmation_state = (
  470. ActionConfirmationStatus.AWAITING_CONFIRMATION
  471. )
  472. self._pending_action = action
  473. if not isinstance(action, NullAction):
  474. if (
  475. hasattr(action, 'confirmation_state')
  476. and action.confirmation_state
  477. == ActionConfirmationStatus.AWAITING_CONFIRMATION
  478. ):
  479. await self.set_agent_state_to(AgentState.AWAITING_USER_CONFIRMATION)
  480. self.event_stream.add_event(action, EventSource.AGENT)
  481. await self.update_state_after_step()
  482. log_level = 'info' if LOG_ALL_EVENTS else 'debug'
  483. self.log(log_level, str(action), extra={'msg_type': 'ACTION'})
  484. async def _delegate_step(self) -> None:
  485. """Executes a single step of the delegate agent."""
  486. await self.delegate._step() # type: ignore[union-attr]
  487. assert self.delegate is not None
  488. delegate_state = self.delegate.get_agent_state()
  489. self.log('debug', f'Delegate state: {delegate_state}')
  490. if delegate_state == AgentState.ERROR:
  491. # update iteration that shall be shared across agents
  492. self.state.iteration = self.delegate.state.iteration
  493. # emit AgentDelegateObservation to mark delegate termination due to error
  494. delegate_outputs = (
  495. self.delegate.state.outputs if self.delegate.state else {}
  496. )
  497. content = (
  498. f'{self.delegate.agent.name} encountered an error during execution.'
  499. )
  500. obs = AgentDelegateObservation(outputs=delegate_outputs, content=content)
  501. self.event_stream.add_event(obs, EventSource.AGENT)
  502. # close the delegate upon error
  503. await self.delegate.close()
  504. # resubscribe parent when delegate is finished
  505. self.event_stream.subscribe(
  506. EventStreamSubscriber.AGENT_CONTROLLER, self.on_event, self.id
  507. )
  508. self.delegate = None
  509. self.delegateAction = None
  510. elif delegate_state in (AgentState.FINISHED, AgentState.REJECTED):
  511. self.log('debug', 'Delegate agent has finished execution')
  512. # retrieve delegate result
  513. outputs = self.delegate.state.outputs if self.delegate.state else {}
  514. # update iteration that shall be shared across agents
  515. self.state.iteration = self.delegate.state.iteration
  516. # close delegate controller: we must close the delegate controller before adding new events
  517. await self.delegate.close()
  518. # resubscribe parent when delegate is finished
  519. self.event_stream.subscribe(
  520. EventStreamSubscriber.AGENT_CONTROLLER, self.on_event, self.id
  521. )
  522. # update delegate result observation
  523. # TODO: replace this with AI-generated summary (#2395)
  524. formatted_output = ', '.join(
  525. f'{key}: {value}' for key, value in outputs.items()
  526. )
  527. content = (
  528. f'{self.delegate.agent.name} finishes task with {formatted_output}'
  529. )
  530. obs = AgentDelegateObservation(outputs=outputs, content=content)
  531. # clean up delegate status
  532. self.delegate = None
  533. self.delegateAction = None
  534. self.event_stream.add_event(obs, EventSource.AGENT)
  535. return
  536. async def _handle_traffic_control(
  537. self, limit_type: str, current_value: float, max_value: float
  538. ) -> bool:
  539. """Handles agent state after hitting the traffic control limit.
  540. Args:
  541. limit_type (str): The type of limit that was hit.
  542. current_value (float): The current value of the limit.
  543. max_value (float): The maximum value of the limit.
  544. """
  545. stop_step = False
  546. if self.state.traffic_control_state == TrafficControlState.PAUSED:
  547. self.log(
  548. 'debug', 'Hitting traffic control, temporarily resume upon user request'
  549. )
  550. self.state.traffic_control_state = TrafficControlState.NORMAL
  551. else:
  552. self.state.traffic_control_state = TrafficControlState.THROTTLING
  553. if self.headless_mode:
  554. e = RuntimeError(
  555. f'Agent reached maximum {limit_type} in headless mode. '
  556. f'Current {limit_type}: {current_value:.2f}, max {limit_type}: {max_value:.2f}'
  557. )
  558. await self._react_to_exception(e)
  559. else:
  560. e = RuntimeError(
  561. f'Agent reached maximum {limit_type}. '
  562. f'Current {limit_type}: {current_value:.2f}, max {limit_type}: {max_value:.2f}. '
  563. )
  564. # FIXME: this isn't really an exception--we should have a different path
  565. await self._react_to_exception(e)
  566. stop_step = True
  567. return stop_step
  568. def get_state(self) -> State:
  569. """Returns the current running state object.
  570. Returns:
  571. State: The current state object.
  572. """
  573. return self.state
  574. def set_initial_state(
  575. self,
  576. state: State | None,
  577. max_iterations: int,
  578. confirmation_mode: bool = False,
  579. ) -> None:
  580. """Sets the initial state for the agent, either from the previous session, or from a parent agent, or by creating a new one.
  581. Args:
  582. state: The state to initialize with, or None to create a new state.
  583. max_iterations: The maximum number of iterations allowed for the task.
  584. confirmation_mode: Whether to enable confirmation mode.
  585. """
  586. # state can come from:
  587. # - the previous session, in which case it has history
  588. # - from a parent agent, in which case it has no history
  589. # - None / a new state
  590. if state is None:
  591. self.state = State(
  592. inputs={},
  593. max_iterations=max_iterations,
  594. confirmation_mode=confirmation_mode,
  595. )
  596. else:
  597. self.state = state
  598. if self.state.start_id <= -1:
  599. self.state.start_id = 0
  600. self.log(
  601. 'debug',
  602. f'AgentController {self.id} initializing history from event {self.state.start_id}',
  603. )
  604. self._init_history()
  605. def _init_history(self) -> None:
  606. """Initializes the agent's history from the event stream.
  607. The history is a list of events that:
  608. - Excludes events of types listed in self.filter_out
  609. - Excludes events with hidden=True attribute
  610. - For delegate events (between AgentDelegateAction and AgentDelegateObservation):
  611. - Excludes all events between the action and observation
  612. - Includes the delegate action and observation themselves
  613. The history is loaded in two parts if truncation_id is set:
  614. 1. First user message from start_id onwards
  615. 2. Rest of history from truncation_id to the end
  616. Otherwise loads normally from start_id.
  617. """
  618. # define range of events to fetch
  619. # delegates start with a start_id and initially won't find any events
  620. # otherwise we're restoring a previous session
  621. start_id = self.state.start_id if self.state.start_id >= 0 else 0
  622. end_id = (
  623. self.state.end_id
  624. if self.state.end_id >= 0
  625. else self.event_stream.get_latest_event_id()
  626. )
  627. # sanity check
  628. if start_id > end_id + 1:
  629. self.log(
  630. 'warning',
  631. f'start_id {start_id} is greater than end_id + 1 ({end_id + 1}). History will be empty.',
  632. )
  633. self.state.history = []
  634. return
  635. events: list[Event] = []
  636. # If we have a truncation point, get first user message and then rest of history
  637. if hasattr(self.state, 'truncation_id') and self.state.truncation_id > 0:
  638. # Find first user message from stream
  639. first_user_msg = next(
  640. (
  641. e
  642. for e in self.event_stream.get_events(
  643. start_id=start_id,
  644. end_id=end_id,
  645. reverse=False,
  646. filter_out_type=self.filter_out,
  647. filter_hidden=True,
  648. )
  649. if isinstance(e, MessageAction) and e.source == EventSource.USER
  650. ),
  651. None,
  652. )
  653. if first_user_msg:
  654. events.append(first_user_msg)
  655. # the rest of the events are from the truncation point
  656. start_id = self.state.truncation_id
  657. # Get rest of history
  658. events_to_add = list(
  659. self.event_stream.get_events(
  660. start_id=start_id,
  661. end_id=end_id,
  662. reverse=False,
  663. filter_out_type=self.filter_out,
  664. filter_hidden=True,
  665. )
  666. )
  667. events.extend(events_to_add)
  668. # Find all delegate action/observation pairs
  669. delegate_ranges: list[tuple[int, int]] = []
  670. delegate_action_ids: list[int] = [] # stack of unmatched delegate action IDs
  671. for event in events:
  672. if isinstance(event, AgentDelegateAction):
  673. delegate_action_ids.append(event.id)
  674. # Note: we can get agent=event.agent and task=event.inputs.get('task','')
  675. # if we need to track these in the future
  676. elif isinstance(event, AgentDelegateObservation):
  677. # Match with most recent unmatched delegate action
  678. if not delegate_action_ids:
  679. self.log(
  680. 'warning',
  681. f'Found AgentDelegateObservation without matching action at id={event.id}',
  682. )
  683. continue
  684. action_id = delegate_action_ids.pop()
  685. delegate_ranges.append((action_id, event.id))
  686. # Filter out events between delegate action/observation pairs
  687. if delegate_ranges:
  688. filtered_events: list[Event] = []
  689. current_idx = 0
  690. for start_id, end_id in sorted(delegate_ranges):
  691. # Add events before delegate range
  692. filtered_events.extend(
  693. event for event in events[current_idx:] if event.id < start_id
  694. )
  695. # Add delegate action and observation
  696. filtered_events.extend(
  697. event for event in events if event.id in (start_id, end_id)
  698. )
  699. # Update index to after delegate range
  700. current_idx = next(
  701. (i for i, e in enumerate(events) if e.id > end_id), len(events)
  702. )
  703. # Add any remaining events after last delegate range
  704. filtered_events.extend(events[current_idx:])
  705. self.state.history = filtered_events
  706. else:
  707. self.state.history = events
  708. # make sure history is in sync
  709. self.state.start_id = start_id
  710. def _apply_conversation_window(self, events: list[Event]) -> list[Event]:
  711. """Cuts history roughly in half when context window is exceeded, preserving action-observation pairs
  712. and ensuring the first user message is always included.
  713. The algorithm:
  714. 1. Cut history in half
  715. 2. Check first event in new history:
  716. - If Observation: find and include its Action
  717. - If MessageAction: ensure its related Action-Observation pair isn't split
  718. 3. Always include the first user message
  719. Args:
  720. events: List of events to filter
  721. Returns:
  722. Filtered list of events keeping newest half while preserving pairs
  723. """
  724. if not events:
  725. return events
  726. # Find first user message - we'll need to ensure it's included
  727. first_user_msg = next(
  728. (
  729. e
  730. for e in events
  731. if isinstance(e, MessageAction) and e.source == EventSource.USER
  732. ),
  733. None,
  734. )
  735. # cut in half
  736. mid_point = max(1, len(events) // 2)
  737. kept_events = events[mid_point:]
  738. # Handle first event in truncated history
  739. if kept_events:
  740. i = 0
  741. while i < len(kept_events):
  742. first_event = kept_events[i]
  743. if isinstance(first_event, Observation) and first_event.cause:
  744. # Find its action and include it
  745. matching_action = next(
  746. (
  747. e
  748. for e in reversed(events[:mid_point])
  749. if isinstance(e, Action) and e.id == first_event.cause
  750. ),
  751. None,
  752. )
  753. if matching_action:
  754. kept_events = [matching_action] + kept_events
  755. else:
  756. self.log(
  757. 'warning',
  758. f'Found Observation without matching Action at id={first_event.id}',
  759. )
  760. # drop this observation
  761. kept_events = kept_events[1:]
  762. break
  763. elif isinstance(first_event, MessageAction) or (
  764. isinstance(first_event, Action)
  765. and first_event.source == EventSource.USER
  766. ):
  767. # if it's a message action or a user action, keep it and continue to find the next event
  768. i += 1
  769. continue
  770. else:
  771. # if it's an action with source == EventSource.AGENT, we're good
  772. break
  773. # Save where to continue from in next reload
  774. if kept_events:
  775. self.state.truncation_id = kept_events[0].id
  776. # Ensure first user message is included
  777. if first_user_msg and first_user_msg not in kept_events:
  778. kept_events = [first_user_msg] + kept_events
  779. # start_id points to first user message
  780. if first_user_msg:
  781. self.state.start_id = first_user_msg.id
  782. return kept_events
  783. def _is_stuck(self) -> bool:
  784. """Checks if the agent or its delegate is stuck in a loop.
  785. Returns:
  786. bool: True if the agent is stuck, False otherwise.
  787. """
  788. # check if delegate stuck
  789. if self.delegate and self.delegate._is_stuck():
  790. return True
  791. return self._stuck_detector.is_stuck()
  792. def __repr__(self):
  793. return (
  794. f'AgentController(id={self.id}, agent={self.agent!r}, '
  795. f'event_stream={self.event_stream!r}, '
  796. f'state={self.state!r}, agent_task={self.agent_task!r}, '
  797. f'delegate={self.delegate!r}, _pending_action={self._pending_action!r})'
  798. )
  799. def _is_awaiting_observation(self):
  800. events = self.event_stream.get_events(reverse=True)
  801. for event in events:
  802. if isinstance(event, AgentStateChangedObservation):
  803. result = event.agent_state == AgentState.RUNNING
  804. return result
  805. return False