Method run_async

src/google/adk/runners.py:932–1134

Main entry method to run the agent in this runner. If event compaction is enabled in the App configuration, it will be performed after all agent events for the current invocation have been yielded. The async generator will only finish iterating after event compaction is complete. Ho

(
      self,
      *,
      user_id: str,
      session_id: str,
      invocation_id: Optional[str] = None,
      new_message: Optional[types.Content] = None,
      state_delta: Optional[dict[str, Any]] = None,
      run_config: Optional[RunConfig] = None,
      yield_user_message: bool = False,
  )

    thread.join()

  async def run_async(
      self,
      *,
      user_id: str,
      session_id: str,
      invocation_id: Optional[str] = None,
      new_message: Optional[types.Content] = None,
      state_delta: Optional[dict[str, Any]] = None,
      run_config: Optional[RunConfig] = None,
      yield_user_message: bool = False,
  ) -> AsyncGenerator[Event, None]:
    """Main entry method to run the agent in this runner.

    If event compaction is enabled in the App configuration, it will be
    performed after all agent events for the current invocation have been
    yielded. The async generator will only finish iterating after event
    compaction is complete. However, this does not block new `run_async`
    calls for subsequent user queries, which can be started concurrently.

    Args:
      user_id: The user ID of the session.
      session_id: The session ID of the session.
      invocation_id: The invocation ID of the session, set this to resume an
        interrupted invocation.
      new_message: A new message to append to the session.
      state_delta: Optional state changes to apply to the session.
      run_config: The run config for the agent.
      yield_user_message: If True, yield the user message event before
        agent/node events.

    Yields:
      The events generated by the agent.

    Raises:
      ValueError: If the session is not found; If both invocation_id and
        new_message are None.
    """
    run_config = run_config or RunConfig()

    if new_message and not new_message.role:
      new_message.role = 'user'

    from .agents.llm_agent import LlmAgent
    from .workflow._base_node import BaseNode

    if isinstance(self.agent, LlmAgent):
      if self.agent.mode is None:
        # LlmAgent as root agent must have chat mode.
        self.agent.mode = 'chat'

      if self.agent.mode == 'chat':
        session = await self._get_or_create_session(
            user_id=user_id, session_id=session_id
        )
        # when the chat coordinator has task-mode sub-agents,
        # the wrapper handles delegation via ctx.run_node. Don't let
        # the legacy sub-agent picker bypass the coordinator on resume.
        has_task_subagent = any(