google-adk 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

google/adk/agents/invocation_context.py

@@ -0,0 +1,181 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+from typing import Optional
+import uuid
+
+from google.genai import types
+from pydantic import BaseModel
+from pydantic import ConfigDict
+
+from ..artifacts.base_artifact_service import BaseArtifactService
+from ..memory.base_memory_service import BaseMemoryService
+from ..sessions.base_session_service import BaseSessionService
+from ..sessions.session import Session
+from .active_streaming_tool import ActiveStreamingTool
+from .base_agent import BaseAgent
+from .live_request_queue import LiveRequestQueue
+from .run_config import RunConfig
+from .transcription_entry import TranscriptionEntry
+
+
+class LlmCallsLimitExceededError(Exception):
+  """Error thrown when the number of LLM calls exceed the limit."""
+
+
+class _InvocationCostManager(BaseModel):
+  """A container to keep track of the cost of invocation.
+
+  While we don't expected the metrics captured here to be a direct
+  representatative of monetary cost incurred in executing the current
+  invocation, but they, in someways have an indirect affect.
+  """
+
+  _number_of_llm_calls: int = 0
+  """A counter that keeps track of number of llm calls made."""
+
+  def increment_and_enforce_llm_calls_limit(
+      self, run_config: Optional[RunConfig]
+  ):
+    """Increments _number_of_llm_calls and enforces the limit."""
+    # We first increment the counter and then check the conditions.
+    self._number_of_llm_calls += 1
+
+    if (
+        run_config
+        and run_config.max_llm_calls > 0
+        and self._number_of_llm_calls > run_config.max_llm_calls
+    ):
+      # We only enforce the limit if the limit is a positive number.
+      raise LlmCallsLimitExceededError(
+          "Max number of llm calls limit of"
+          f" `{run_config.max_llm_calls}` exceeded"
+      )
+
+
+class InvocationContext(BaseModel):
+  """An invocation context represents the data of a single invocation of an agent.
+
+  An invocation:
+    1. Starts with a user message and ends with a final response.
+    2. Can contain one or multiple agent calls.
+    3. Is handled by runner.run_async().
+
+  An invocation runs an agent until it does not request to transfer to another
+  agent.
+
+  An agent call:
+    1. Is handled by agent.run().
+    2. Ends when agent.run() ends.
+
+  An LLM agent call is an agent with a BaseLLMFlow.
+  An LLM agent call can contain one or multiple steps.
+
+  An LLM agent runs steps in a loop until:
+    1. A final response is generated.
+    2. The agent transfers to another agent.
+    3. The end_invocation is set to true by any callbacks or tools.
+
+  A step:
+    1. Calls the LLM only once and yields its response.
+    2. Calls the tools and yields their responses if requested.
+
+  The summarization of the function response is considered another step, since
+  it is another llm call.
+  A step ends when it's done calling llm and tools, or if the end_invocation
+  is set to true at any time.
+
+  ```
+     ┌─────────────────────── invocation ──────────────────────────┐
+     ┌──────────── llm_agent_call_1 ────────────┐ ┌─ agent_call_2 ─┐
+     ┌──── step_1 ────────┐ ┌───── step_2 ──────┐
+     [call_llm] [call_tool] [call_llm] [transfer]
+  ```
+  """
+
+  model_config = ConfigDict(
+      arbitrary_types_allowed=True,
+      extra="forbid",
+  )
+
+  artifact_service: Optional[BaseArtifactService] = None
+  session_service: BaseSessionService
+  memory_service: Optional[BaseMemoryService] = None
+
+  invocation_id: str
+  """The id of this invocation context. Readonly."""
+  branch: Optional[str] = None
+  """The branch of the invocation context.
+
+  The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of
+  agent_2, and agent_2 is the parent of agent_3.
+
+  Branch is used when multiple sub-agents shouldn't see their peer agents'
+  conversaction history.
+  """
+  agent: BaseAgent
+  """The current agent of this invocation context. Readonly."""
+  user_content: Optional[types.Content] = None
+  """The user content that started this invocation. Readonly."""
+  session: Session
+  """The current session of this invocation context. Readonly."""
+
+  end_invocation: bool = False
+  """Whether to end this invocation.
+
+  Set to True in callbacks or tools to terminate this invocation."""
+
+  live_request_queue: Optional[LiveRequestQueue] = None
+  """The queue to receive live requests."""
+
+  active_streaming_tools: Optional[dict[str, ActiveStreamingTool]] = None
+  """The running streaming tools of this invocation."""
+
+  transcription_cache: Optional[list[TranscriptionEntry]] = None
+  """Caches necessary, data audio or contents, that are needed by transcription."""
+
+  run_config: Optional[RunConfig] = None
+  """Configurations for live agents under this invocation."""
+
+  _invocation_cost_manager: _InvocationCostManager = _InvocationCostManager()
+  """A container to keep track of different kinds of costs incurred as a part
+  of this invocation.
+  """
+
+  def increment_llm_call_count(
+      self,
+  ):
+    """Tracks number of llm calls made.
+
+    Raises:
+      LlmCallsLimitExceededError: If number of llm calls made exceed the set
+        threshold.
+    """
+    self._invocation_cost_manager.increment_and_enforce_llm_calls_limit(
+        self.run_config
+    )
+
+  @property
+  def app_name(self) -> str:
+    return self.session.app_name
+
+  @property
+  def user_id(self) -> str:
+    return self.session.user_id
+
+
+def new_invocation_context_id() -> str:
+  return "e-" + str(uuid.uuid4())

google/adk/agents/langgraph_agent.py

@@ -0,0 +1,140 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import AsyncGenerator
+from typing import Union
+
+from google.genai import types
+from langchain_core.messages import AIMessage
+from langchain_core.messages import HumanMessage
+from langchain_core.messages import SystemMessage
+from langchain_core.runnables.config import RunnableConfig
+from langgraph.graph.graph import CompiledGraph
+from pydantic import ConfigDict
+from typing_extensions import override
+
+from ..events.event import Event
+from .base_agent import BaseAgent
+from .invocation_context import InvocationContext
+
+
+def _get_last_human_messages(events: list[Event]) -> list[HumanMessage]:
+  """Extracts last human messages from given list of events.
+
+  Args:
+    events: the list of events
+
+  Returns:
+    list of last human messages
+  """
+  messages = []
+  for event in reversed(events):
+    if messages and event.author != 'user':
+      break
+    if event.author == 'user' and event.content and event.content.parts:
+      messages.append(HumanMessage(content=event.content.parts[0].text))
+  return list(reversed(messages))
+
+
+class LangGraphAgent(BaseAgent):
+  """Currently a concept implementation, supports single and multi-turn."""
+
+  model_config = ConfigDict(
+      arbitrary_types_allowed=True,
+  )
+
+  graph: CompiledGraph
+
+  instruction: str = ''
+
+  @override
+  async def _run_async_impl(
+      self,
+      ctx: InvocationContext,
+  ) -> AsyncGenerator[Event, None]:
+
+    # Needed for langgraph checkpointer (for subsequent invocations; multi-turn)
+    config: RunnableConfig = {'configurable': {'thread_id': ctx.session.id}}
+
+    # Add instruction as SystemMessage if graph state is empty
+    current_graph_state = self.graph.get_state(config)
+    graph_messages = (
+        current_graph_state.values.get('messages', [])
+        if current_graph_state.values
+        else []
+    )
+    messages = (
+        [SystemMessage(content=self.instruction)]
+        if self.instruction and not graph_messages
+        else []
+    )
+    # Add events to messages (evaluating the memory used; parent agent vs checkpointer)
+    messages += self._get_messages(ctx.session.events)
+
+    # Use the Runnable
+    final_state = self.graph.invoke({'messages': messages}, config)
+    result = final_state['messages'][-1].content
+
+    result_event = Event(
+        invocation_id=ctx.invocation_id,
+        author=self.name,
+        branch=ctx.branch,
+        content=types.Content(
+            role='model',
+            parts=[types.Part.from_text(text=result)],
+        ),
+    )
+    yield result_event
+
+  def _get_messages(
+      self, events: list[Event]
+  ) -> list[Union[HumanMessage, AIMessage]]:
+    """Extracts messages from given list of events.
+
+    If the developer provides their own memory within langgraph, we return the
+    last user messages only. Otherwise, we return all messages between the user
+    and the agent.
+
+    Args:
+      events: the list of events
+
+    Returns:
+      list of messages
+    """
+    if self.graph.checkpointer:
+      return _get_last_human_messages(events)
+    else:
+      return self._get_conversation_with_agent(events)
+
+  def _get_conversation_with_agent(
+      self, events: list[Event]
+  ) -> list[Union[HumanMessage, AIMessage]]:
+    """Extracts messages from given list of events.
+
+    Args:
+      events: the list of events
+
+    Returns:
+      list of messages
+    """
+
+    messages = []
+    for event in events:
+      if not event.content or not event.content.parts:
+        continue
+      if event.author == 'user':
+        messages.append(HumanMessage(content=event.content.parts[0].text))
+      elif event.author == self.name:
+        messages.append(AIMessage(content=event.content.parts[0].text))
+    return messages

google/adk/agents/live_request_queue.py

@@ -0,0 +1,64 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import asyncio
+from typing import Optional
+
+from google.genai import types
+from pydantic import BaseModel
+from pydantic import ConfigDict
+
+
+class LiveRequest(BaseModel):
+  """Request send to live agents."""
+
+  model_config = ConfigDict(ser_json_bytes='base64', val_json_bytes='base64')
+
+  content: Optional[types.Content] = None
+  """If set, send the content to the model in turn-by-turn mode."""
+  blob: Optional[types.Blob] = None
+  """If set, send the blob to the model in realtime mode."""
+  close: bool = False
+  """If set, close the queue. queue.shutdown() is only supported in Python 3.13+."""
+
+
+class LiveRequestQueue:
+  """Queue used to send LiveRequest in a live(bidirectional streaming) way."""
+
+  def __init__(self):
+    # Ensure there's an event loop available in this thread
+    try:
+      asyncio.get_running_loop()
+    except RuntimeError:
+      # No running loop, create one
+      loop = asyncio.new_event_loop()
+      asyncio.set_event_loop(loop)
+
+    # Now create the queue (it will use the event loop we just ensured exists)
+    self._queue = asyncio.Queue()
+
+  def close(self):
+    self._queue.put_nowait(LiveRequest(close=True))
+
+  def send_content(self, content: types.Content):
+    self._queue.put_nowait(LiveRequest(content=content))
+
+  def send_realtime(self, blob: types.Blob):
+    self._queue.put_nowait(LiveRequest(blob=blob))
+
+  def send(self, req: LiveRequest):
+    self._queue.put_nowait(req)
+
+  async def get(self) -> LiveRequest:
+    return await self._queue.get()