forked from google/adk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathllm_agent.py
More file actions
943 lines (801 loc) · 32.4 KB
/
llm_agent.py
File metadata and controls
943 lines (801 loc) · 32.4 KB
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
# 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
import importlib
import inspect
import logging
from typing import Any
from typing import AsyncGenerator
from typing import Awaitable
from typing import Callable
from typing import cast
from typing import ClassVar
from typing import Dict
from typing import Literal
from typing import Optional
from typing import Type
from typing import Union
import warnings
from google.genai import types
from pydantic import BaseModel
from pydantic import Field
from pydantic import field_validator
from pydantic import model_validator
from typing_extensions import override
from typing_extensions import TypeAlias
from ..code_executors.base_code_executor import BaseCodeExecutor
from ..events.event import Event
from ..flows.llm_flows.auto_flow import AutoFlow
from ..flows.llm_flows.base_llm_flow import BaseLlmFlow
from ..flows.llm_flows.single_flow import SingleFlow
from ..models.base_llm import BaseLlm
from ..models.llm_request import LlmRequest
from ..models.llm_response import LlmResponse
from ..models.registry import LLMRegistry
from ..planners.base_planner import BasePlanner
from ..tools.base_tool import BaseTool
from ..tools.base_toolset import BaseToolset
from ..tools.function_tool import FunctionTool
from ..tools.tool_configs import ToolConfig
from ..tools.tool_context import ToolContext
from ..utils.context_utils import Aclosing
from ..utils.error_messages import format_not_found_error
from ..utils.feature_decorator import experimental
from .base_agent import BaseAgent
from .base_agent import BaseAgentState
from .base_agent_config import BaseAgentConfig
from .callback_context import CallbackContext
from .invocation_context import InvocationContext
from .llm_agent_config import LlmAgentConfig
from .readonly_context import ReadonlyContext
logger = logging.getLogger('google_adk.' + __name__)
_SingleBeforeModelCallback: TypeAlias = Callable[
[CallbackContext, LlmRequest],
Union[Awaitable[Optional[LlmResponse]], Optional[LlmResponse]],
]
BeforeModelCallback: TypeAlias = Union[
_SingleBeforeModelCallback,
list[_SingleBeforeModelCallback],
]
_SingleAfterModelCallback: TypeAlias = Callable[
[CallbackContext, LlmResponse],
Union[Awaitable[Optional[LlmResponse]], Optional[LlmResponse]],
]
AfterModelCallback: TypeAlias = Union[
_SingleAfterModelCallback,
list[_SingleAfterModelCallback],
]
_SingleBeforeToolCallback: TypeAlias = Callable[
[BaseTool, dict[str, Any], ToolContext],
Union[Awaitable[Optional[dict]], Optional[dict]],
]
BeforeToolCallback: TypeAlias = Union[
_SingleBeforeToolCallback,
list[_SingleBeforeToolCallback],
]
_SingleAfterToolCallback: TypeAlias = Callable[
[BaseTool, dict[str, Any], ToolContext, dict],
Union[Awaitable[Optional[dict]], Optional[dict]],
]
AfterToolCallback: TypeAlias = Union[
_SingleAfterToolCallback,
list[_SingleAfterToolCallback],
]
_SingleOnToolErrorCallback: TypeAlias = Callable[
[BaseTool, dict[str, Any], ToolContext, Exception],
Union[Awaitable[Optional[dict]], Optional[dict]],
]
OnToolErrorCallback: TypeAlias = Union[
_SingleOnToolErrorCallback,
list[_SingleOnToolErrorCallback],
]
InstructionProvider: TypeAlias = Callable[
[ReadonlyContext], Union[str, Awaitable[str]]
]
ToolUnion: TypeAlias = Union[Callable, BaseTool, BaseToolset]
async def _convert_tool_union_to_tools(
tool_union: ToolUnion,
ctx: ReadonlyContext,
model: Union[str, BaseLlm],
multiple_tools: bool = False,
) -> list[BaseTool]:
from ..tools.google_search_tool import GoogleSearchTool
from ..tools.vertex_ai_search_tool import VertexAiSearchTool
# Wrap google_search tool with AgentTool if there are multiple tools because
# the built-in tools cannot be used together with other tools.
# TODO(b/448114567): Remove once the workaround is no longer needed.
if multiple_tools and isinstance(tool_union, GoogleSearchTool):
from ..tools.google_search_agent_tool import create_google_search_agent
from ..tools.google_search_agent_tool import GoogleSearchAgentTool
search_tool = cast(GoogleSearchTool, tool_union)
if search_tool.bypass_multi_tools_limit:
return [GoogleSearchAgentTool(create_google_search_agent(model))]
# Replace VertexAiSearchTool with DiscoveryEngineSearchTool if there are
# multiple tools because the built-in tools cannot be used together with
# other tools.
# TODO(b/448114567): Remove once the workaround is no longer needed.
if multiple_tools and isinstance(tool_union, VertexAiSearchTool):
from ..tools.discovery_engine_search_tool import DiscoveryEngineSearchTool
vais_tool = cast(VertexAiSearchTool, tool_union)
if vais_tool.bypass_multi_tools_limit:
return [
DiscoveryEngineSearchTool(
data_store_id=vais_tool.data_store_id,
data_store_specs=vais_tool.data_store_specs,
search_engine_id=vais_tool.search_engine_id,
filter=vais_tool.filter,
max_results=vais_tool.max_results,
)
]
if isinstance(tool_union, BaseTool):
return [tool_union]
if callable(tool_union):
return [FunctionTool(func=tool_union)]
# At this point, tool_union must be a BaseToolset
return await tool_union.get_tools_with_prefix(ctx)
class LlmAgent(BaseAgent):
"""LLM-based Agent."""
model: Union[str, BaseLlm] = ''
"""The model to use for the agent.
When not set, the agent will inherit the model from its ancestor.
"""
config_type: ClassVar[Type[BaseAgentConfig]] = LlmAgentConfig
"""The config type for this agent."""
instruction: Union[str, InstructionProvider] = ''
"""Dynamic instructions for the LLM model, guiding the agent's behavior.
These instructions can contain placeholders like {variable_name} that will be
resolved at runtime using session state and context.
**Behavior depends on static_instruction:**
- If static_instruction is None: instruction goes to system_instruction
- If static_instruction is set: instruction goes to user content in the request
This allows for context caching optimization where static content (static_instruction)
comes first in the prompt, followed by dynamic content (instruction).
"""
global_instruction: Union[str, InstructionProvider] = ''
"""Instructions for all the agents in the entire agent tree.
DEPRECATED: This field is deprecated and will be removed in a future version.
Use GlobalInstructionPlugin instead, which provides the same functionality
at the App level. See migration guide for details.
ONLY the global_instruction in root agent will take effect.
For example: use global_instruction to make all agents have a stable identity
or personality.
"""
static_instruction: Optional[types.ContentUnion] = None
"""Static instruction content sent literally as system instruction at the beginning.
This field is for content that never changes and doesn't contain placeholders.
It's sent directly to the model without any processing or variable substitution.
This field is primarily for context caching optimization. Static instructions
are sent as system instruction at the beginning of the request, allowing
for improved performance when the static portion remains unchanged. Live API
has its own cache mechanism, thus this field doesn't work with Live API.
**Impact on instruction field:**
- When static_instruction is None: instruction → system_instruction
- When static_instruction is set: instruction → user content (after static content)
**Context Caching:**
- **Implicit Cache**: Automatic caching by model providers (no config needed)
- **Explicit Cache**: Cache explicitly created by user for instructions, tools and contents
See below for more information of Implicit Cache and Explicit Cache
Gemini API: https://ai.google.dev/gemini-api/docs/caching?lang=python
Vertex API: https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview
Setting static_instruction alone does NOT enable caching automatically.
For explicit caching control, configure context_cache_config at App level.
**Content Support:**
Accepts types.ContentUnion which includes:
- str: Simple text instruction
- types.Content: Rich content object
- types.Part: Single part (text, inline_data, file_data, etc.)
- PIL.Image.Image: Image object
- types.File: File reference
- list[PartUnion]: List of parts
**Examples:**
```python
# Simple string instruction
static_instruction = "You are a helpful assistant."
# Rich content with files
static_instruction = types.Content(
role='user',
parts=[
types.Part(text='You are a helpful assistant.'),
types.Part(file_data=types.FileData(...))
]
)
```
"""
tools: list[ToolUnion] = Field(default_factory=list)
"""Tools available to this agent."""
generate_content_config: Optional[types.GenerateContentConfig] = None
"""The additional content generation configurations.
NOTE: not all fields are usable, e.g. tools must be configured via `tools`,
thinking_config must be configured via `planner` in LlmAgent.
For example: use this config to adjust model temperature, configure safety
settings, etc.
"""
# LLM-based agent transfer configs - Start
disallow_transfer_to_parent: bool = False
"""Disallows LLM-controlled transferring to the parent agent.
NOTE: Setting this as True also prevents this agent from continuing to reply
to the end-user, and will transfer control back to the parent agent in the
next turn. This behavior prevents one-way transfer, in which end-user may be
stuck with one agent that cannot transfer to other agents in the agent tree.
"""
disallow_transfer_to_peers: bool = False
"""Disallows LLM-controlled transferring to the peer agents."""
# LLM-based agent transfer configs - End
include_contents: Literal['default', 'none'] = 'default'
"""Controls content inclusion in model requests.
Options:
default: Model receives relevant conversation history
none: Model receives no prior history, operates solely on current
instruction and input
"""
# Controlled input/output configurations - Start
input_schema: Optional[type[BaseModel]] = None
"""The input schema when agent is used as a tool."""
output_schema: Optional[type[BaseModel]] = None
"""The output schema when agent replies.
NOTE:
When this is set, agent can ONLY reply and CANNOT use any tools, such as
function tools, RAGs, agent transfer, etc.
"""
output_key: Optional[str] = None
"""The key in session state to store the output of the agent.
Typically use cases:
- Extracts agent reply for later use, such as in tools, callbacks, etc.
- Connects agents to coordinate with each other.
"""
# Controlled input/output configurations - End
# Advance features - Start
planner: Optional[BasePlanner] = None
"""Instructs the agent to make a plan and execute it step by step.
NOTE:
To use model's built-in thinking features, set the `thinking_config`
field in `google.adk.planners.built_in_planner`.
"""
code_executor: Optional[BaseCodeExecutor] = None
"""Allow agent to execute code blocks from model responses using the provided
CodeExecutor.
Check out available code executions in `google.adk.code_executor` package.
NOTE:
To use model's built-in code executor, use the `BuiltInCodeExecutor`.
"""
# Advance features - End
# Callbacks - Start
before_model_callback: Optional[BeforeModelCallback] = None
"""Callback or list of callbacks to be called before calling the LLM.
When a list of callbacks is provided, the callbacks will be called in the
order they are listed until a callback does not return None.
Args:
callback_context: CallbackContext,
llm_request: LlmRequest, The raw model request. Callback can mutate the
request.
Returns:
The content to return to the user. When present, the model call will be
skipped and the provided content will be returned to user.
"""
after_model_callback: Optional[AfterModelCallback] = None
"""Callback or list of callbacks to be called after calling the LLM.
When a list of callbacks is provided, the callbacks will be called in the
order they are listed until a callback does not return None.
Args:
callback_context: CallbackContext,
llm_response: LlmResponse, the actual model response.
Returns:
The content to return to the user. When present, the actual model response
will be ignored and the provided content will be returned to user.
"""
before_tool_callback: Optional[BeforeToolCallback] = None
"""Callback or list of callbacks to be called before calling the tool.
When a list of callbacks is provided, the callbacks will be called in the
order they are listed until a callback does not return None.
Args:
tool: The tool to be called.
args: The arguments to the tool.
tool_context: ToolContext,
Returns:
The tool response. When present, the returned tool response will be used and
the framework will skip calling the actual tool.
"""
after_tool_callback: Optional[AfterToolCallback] = None
"""Callback or list of callbacks to be called after calling the tool.
When a list of callbacks is provided, the callbacks will be called in the
order they are listed until a callback does not return None.
Args:
tool: The tool to be called.
args: The arguments to the tool.
tool_context: ToolContext,
tool_response: The response from the tool.
Returns:
When present, the returned dict will be used as tool result.
"""
on_tool_error_callback: Optional[OnToolErrorCallback] = None
"""Callback or list of callbacks to be called when a tool call encounters an error.
When a list of callbacks is provided, the callbacks will be called in the
order they are listed until a callback does not return None.
Args:
tool: The tool to be called.
args: The arguments to the tool.
tool_context: ToolContext,
error: The error from the tool call.
Returns:
When present, the returned dict will be used as tool result.
"""
# Callbacks - End
@override
async def _run_async_impl(
self, ctx: InvocationContext
) -> AsyncGenerator[Event, None]:
agent_state = self._load_agent_state(ctx, BaseAgentState)
# If there is an sub-agent to resume, run it and then end the current
# agent.
if agent_state is not None and (
agent_to_transfer := self._get_subagent_to_resume(ctx)
):
async with Aclosing(agent_to_transfer.run_async(ctx)) as agen:
async for event in agen:
yield event
ctx.set_agent_state(self.name, end_of_agent=True)
yield self._create_agent_state_event(ctx)
return
should_pause = False
async with Aclosing(self._llm_flow.run_async(ctx)) as agen:
async for event in agen:
self.__maybe_save_output_to_state(event)
yield event
if ctx.should_pause_invocation(event):
# Do not pause immediately, wait until the long running tool call is
# executed.
should_pause = True
if should_pause:
return
if ctx.is_resumable:
events = ctx._get_events(current_invocation=True, current_branch=True)
if events and (
ctx.should_pause_invocation(events[-1])
or ctx.should_pause_invocation(events[-2])
):
return
# Only yield an end state if the last event is no longer a long running
# tool call.
ctx.set_agent_state(self.name, end_of_agent=True)
yield self._create_agent_state_event(ctx)
@override
async def _run_live_impl(
self, ctx: InvocationContext
) -> AsyncGenerator[Event, None]:
async with Aclosing(self._llm_flow.run_live(ctx)) as agen:
async for event in agen:
self.__maybe_save_output_to_state(event)
yield event
if ctx.end_invocation:
return
@property
def canonical_model(self) -> BaseLlm:
"""The resolved self.model field as BaseLlm.
This method is only for use by Agent Development Kit.
"""
if isinstance(self.model, BaseLlm):
return self.model
elif self.model: # model is non-empty str
return LLMRegistry.new_llm(self.model)
else: # find model from ancestors.
ancestor_agent = self.parent_agent
while ancestor_agent is not None:
if isinstance(ancestor_agent, LlmAgent):
return ancestor_agent.canonical_model
ancestor_agent = ancestor_agent.parent_agent
raise ValueError(f'No model found for {self.name}.')
async def canonical_instruction(
self, ctx: ReadonlyContext
) -> tuple[str, bool]:
"""The resolved self.instruction field to construct instruction for this agent.
This method is only for use by Agent Development Kit.
Args:
ctx: The context to retrieve the session state.
Returns:
A tuple of (instruction, bypass_state_injection).
instruction: The resolved self.instruction field.
bypass_state_injection: Whether the instruction is based on
InstructionProvider.
"""
if isinstance(self.instruction, str):
return self.instruction, False
else:
instruction = self.instruction(ctx)
if inspect.isawaitable(instruction):
instruction = await instruction
return instruction, True
async def canonical_global_instruction(
self, ctx: ReadonlyContext
) -> tuple[str, bool]:
"""The resolved self.instruction field to construct global instruction.
This method is only for use by Agent Development Kit.
Args:
ctx: The context to retrieve the session state.
Returns:
A tuple of (instruction, bypass_state_injection).
instruction: The resolved self.global_instruction field.
bypass_state_injection: Whether the instruction is based on
InstructionProvider.
"""
# Issue deprecation warning if global_instruction is being used
if self.global_instruction:
warnings.warn(
'global_instruction field is deprecated and will be removed in a'
' future version. Use GlobalInstructionPlugin instead for the same'
' functionality at the App level. See migration guide for details.',
DeprecationWarning,
stacklevel=2,
)
if isinstance(self.global_instruction, str):
return self.global_instruction, False
else:
global_instruction = self.global_instruction(ctx)
if inspect.isawaitable(global_instruction):
global_instruction = await global_instruction
return global_instruction, True
async def canonical_tools(
self, ctx: ReadonlyContext = None
) -> list[BaseTool]:
"""The resolved self.tools field as a list of BaseTool based on the context.
This method is only for use by Agent Development Kit.
"""
resolved_tools = []
# We may need to wrap some built-in tools if there are other tools
# because the built-in tools cannot be used together with other tools.
# TODO(b/448114567): Remove once the workaround is no longer needed.
multiple_tools = len(self.tools) > 1
for tool_union in self.tools:
resolved_tools.extend(
await _convert_tool_union_to_tools(
tool_union, ctx, self.model, multiple_tools
)
)
return resolved_tools
@property
def canonical_before_model_callbacks(
self,
) -> list[_SingleBeforeModelCallback]:
"""The resolved self.before_model_callback field as a list of _SingleBeforeModelCallback.
This method is only for use by Agent Development Kit.
"""
if not self.before_model_callback:
return []
if isinstance(self.before_model_callback, list):
return self.before_model_callback
return [self.before_model_callback]
@property
def canonical_after_model_callbacks(self) -> list[_SingleAfterModelCallback]:
"""The resolved self.after_model_callback field as a list of _SingleAfterModelCallback.
This method is only for use by Agent Development Kit.
"""
if not self.after_model_callback:
return []
if isinstance(self.after_model_callback, list):
return self.after_model_callback
return [self.after_model_callback]
@property
def canonical_before_tool_callbacks(
self,
) -> list[BeforeToolCallback]:
"""The resolved self.before_tool_callback field as a list of BeforeToolCallback.
This method is only for use by Agent Development Kit.
"""
if not self.before_tool_callback:
return []
if isinstance(self.before_tool_callback, list):
return self.before_tool_callback
return [self.before_tool_callback]
@property
def canonical_after_tool_callbacks(
self,
) -> list[AfterToolCallback]:
"""The resolved self.after_tool_callback field as a list of AfterToolCallback.
This method is only for use by Agent Development Kit.
"""
if not self.after_tool_callback:
return []
if isinstance(self.after_tool_callback, list):
return self.after_tool_callback
return [self.after_tool_callback]
@property
def canonical_on_tool_error_callbacks(
self,
) -> list[OnToolErrorCallback]:
"""The resolved self.on_tool_error_callback field as a list of OnToolErrorCallback.
This method is only for use by Agent Development Kit.
"""
if not self.on_tool_error_callback:
return []
if isinstance(self.on_tool_error_callback, list):
return self.on_tool_error_callback
return [self.on_tool_error_callback]
@property
def _llm_flow(self) -> BaseLlmFlow:
if (
self.disallow_transfer_to_parent
and self.disallow_transfer_to_peers
and not self.sub_agents
):
return SingleFlow()
else:
return AutoFlow()
def _get_subagent_to_resume(
self, ctx: InvocationContext
) -> Optional[BaseAgent]:
"""Returns the sub-agent in the llm tree to resume if it exists.
There are 2 cases where we need to transfer to and resume a sub-agent:
1. The last event is a transfer to agent response from the current agent.
In this case, we need to return the agent specified in the response.
2. The last event's author isn't the current agent, or the user is
responding to another agent's tool call.
In this case, we need to return the LAST agent being transferred to
from the current agent.
"""
events = ctx._get_events(current_invocation=True, current_branch=True)
if not events:
return None
last_event = events[-1]
if last_event.author == self.name:
# Last event is from current agent. Return transfer_to_agent in the event
# if it exists, or None.
return self.__get_transfer_to_agent_or_none(last_event, self.name)
# Last event is from user or another agent.
if last_event.author == 'user':
function_call_event = ctx._find_matching_function_call(last_event)
if not function_call_event:
raise ValueError(
'No agent to transfer to for resuming agent from function response'
f' {self.name}'
)
if function_call_event.author == self.name:
# User is responding to a tool call from the current agent.
# Current agent should continue, so no sub-agent to resume.
return None
# Last event is from another agent, or from user for another agent's tool
# call. We need to find the last agent we transferred to.
for event in reversed(events):
if agent := self.__get_transfer_to_agent_or_none(event, self.name):
return agent
return None
def __get_agent_to_run(self, agent_name: str) -> BaseAgent:
"""Find the agent to run under the root agent by name."""
agent_to_run = self.root_agent.find_agent(agent_name)
if not agent_to_run:
error_msg = format_not_found_error(
item_name=agent_name,
item_type='agent',
available_items=self._get_available_agent_names(),
causes=[
'Agent not registered before being referenced',
'Agent name mismatch (typo or case sensitivity)',
'Timing issue (agent referenced before creation)',
],
fixes=[
'Verify agent is registered with root agent',
'Check agent name spelling and case',
'Ensure agents are created before being referenced',
],
)
raise ValueError(error_msg)
return agent_to_run
def _get_available_agent_names(self) -> list[str]:
"""Helper to get all agent names in the tree for error reporting.
This is a private helper method used only for error message formatting.
Traverses the agent tree starting from root_agent and collects all
agent names for display in error messages.
Returns:
List of all agent names in the agent tree.
"""
agents = []
def collect_agents(agent):
agents.append(agent.name)
if hasattr(agent, 'sub_agents') and agent.sub_agents:
for sub_agent in agent.sub_agents:
collect_agents(sub_agent)
collect_agents(self.root_agent)
return agents
def __get_transfer_to_agent_or_none(
self, event: Event, from_agent: str
) -> Optional[BaseAgent]:
"""Returns the agent to run if the event is a transfer to agent response."""
function_responses = event.get_function_responses()
if not function_responses:
return None
for function_response in function_responses:
if (
function_response.name == 'transfer_to_agent'
and event.author == from_agent
and event.actions.transfer_to_agent != from_agent
):
return self.__get_agent_to_run(event.actions.transfer_to_agent)
return None
def __maybe_save_output_to_state(self, event: Event):
"""Saves the model output to state if needed."""
# skip if the event was authored by some other agent (e.g. current agent
# transferred to another agent)
if event.author != self.name:
logger.debug(
'Skipping output save for agent %s: event authored by %s',
self.name,
event.author,
)
return
if (
self.output_key
and event.is_final_response()
and event.content
and event.content.parts
):
result = ''.join(
part.text
for part in event.content.parts
if part.text and not part.thought
)
if self.output_schema:
# If the result from the final chunk is just whitespace or empty,
# it means this is an empty final chunk of a stream.
# Do not attempt to parse it as JSON.
if not result.strip():
return
result = self.output_schema.model_validate_json(result).model_dump(
exclude_none=True
)
event.actions.state_delta[self.output_key] = result
@model_validator(mode='after')
def __model_validator_after(self) -> LlmAgent:
self.__check_output_schema()
return self
def __check_output_schema(self):
if not self.output_schema:
return
if (
not self.disallow_transfer_to_parent
or not self.disallow_transfer_to_peers
):
logger.warning(
'Invalid config for agent %s: output_schema cannot co-exist with'
' agent transfer configurations. Setting'
' disallow_transfer_to_parent=True, disallow_transfer_to_peers=True',
self.name,
)
self.disallow_transfer_to_parent = True
self.disallow_transfer_to_peers = True
if self.sub_agents:
raise ValueError(
f'Invalid config for agent {self.name}: if output_schema is set,'
' sub_agents must be empty to disable agent transfer.'
)
@field_validator('generate_content_config', mode='after')
@classmethod
def validate_generate_content_config(
cls, generate_content_config: Optional[types.GenerateContentConfig]
) -> types.GenerateContentConfig:
if not generate_content_config:
return types.GenerateContentConfig()
if generate_content_config.thinking_config:
raise ValueError('Thinking config should be set via LlmAgent.planner.')
if generate_content_config.tools:
raise ValueError('All tools must be set via LlmAgent.tools.')
if generate_content_config.system_instruction:
raise ValueError(
'System instruction must be set via LlmAgent.instruction.'
)
if generate_content_config.response_schema:
raise ValueError(
'Response schema must be set via LlmAgent.output_schema.'
)
return generate_content_config
@classmethod
@experimental
def _resolve_tools(
cls, tool_configs: list[ToolConfig], config_abs_path: str
) -> list[Any]:
"""Resolve tools from configuration.
Args:
tool_configs: List of tool configurations (ToolConfig objects).
config_abs_path: The absolute path to the agent config file.
Returns:
List of resolved tool objects.
"""
resolved_tools = []
for tool_config in tool_configs:
if '.' not in tool_config.name:
# ADK built-in tools
module = importlib.import_module('google.adk.tools')
obj = getattr(module, tool_config.name)
else:
# User-defined tools
module_path, obj_name = tool_config.name.rsplit('.', 1)
module = importlib.import_module(module_path)
obj = getattr(module, obj_name)
if isinstance(obj, BaseTool) or isinstance(obj, BaseToolset):
logger.debug(
'Tool %s is an instance of BaseTool/BaseToolset.', tool_config.name
)
resolved_tools.append(obj)
elif inspect.isclass(obj) and (
issubclass(obj, BaseTool) or issubclass(obj, BaseToolset)
):
logger.debug(
'Tool %s is a sub-class of BaseTool/BaseToolset.', tool_config.name
)
resolved_tools.append(
obj.from_config(tool_config.args, config_abs_path)
)
elif callable(obj):
if tool_config.args:
logger.debug(
'Tool %s is a user-defined tool-generating function.',
tool_config.name,
)
resolved_tools.append(obj(tool_config.args))
else:
logger.debug(
'Tool %s is a user-defined function tool.', tool_config.name
)
resolved_tools.append(obj)
else:
raise ValueError(f'Invalid tool YAML config: {tool_config}.')
return resolved_tools
@override
@classmethod
@experimental
def _parse_config(
cls: Type[LlmAgent],
config: LlmAgentConfig,
config_abs_path: str,
kwargs: Dict[str, Any],
) -> Dict[str, Any]:
from .config_agent_utils import resolve_callbacks
from .config_agent_utils import resolve_code_reference
if config.model:
kwargs['model'] = config.model
if config.instruction:
kwargs['instruction'] = config.instruction
if config.static_instruction:
kwargs['static_instruction'] = config.static_instruction
if config.disallow_transfer_to_parent:
kwargs['disallow_transfer_to_parent'] = config.disallow_transfer_to_parent
if config.disallow_transfer_to_peers:
kwargs['disallow_transfer_to_peers'] = config.disallow_transfer_to_peers
if config.include_contents != 'default':
kwargs['include_contents'] = config.include_contents
if config.input_schema:
kwargs['input_schema'] = resolve_code_reference(config.input_schema)
if config.output_schema:
kwargs['output_schema'] = resolve_code_reference(config.output_schema)
if config.output_key:
kwargs['output_key'] = config.output_key
if config.tools:
kwargs['tools'] = cls._resolve_tools(config.tools, config_abs_path)
if config.before_model_callbacks:
kwargs['before_model_callback'] = resolve_callbacks(
config.before_model_callbacks
)
if config.after_model_callbacks:
kwargs['after_model_callback'] = resolve_callbacks(
config.after_model_callbacks
)
if config.before_tool_callbacks:
kwargs['before_tool_callback'] = resolve_callbacks(
config.before_tool_callbacks
)
if config.after_tool_callbacks:
kwargs['after_tool_callback'] = resolve_callbacks(
config.after_tool_callbacks
)
if config.generate_content_config:
kwargs['generate_content_config'] = config.generate_content_config
return kwargs
Agent: TypeAlias = LlmAgent