-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy path_agent_graph.py
More file actions
1795 lines (1545 loc) · 81 KB
/
_agent_graph.py
File metadata and controls
1795 lines (1545 loc) · 81 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
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations as _annotations
import asyncio
import dataclasses
import inspect
import uuid
from asyncio import Task
from collections import defaultdict, deque
from collections.abc import AsyncIterator, Awaitable, Callable, Iterator, Sequence
from contextlib import asynccontextmanager, contextmanager
from contextvars import ContextVar
from copy import deepcopy
from dataclasses import field, replace
from typing import TYPE_CHECKING, Any, Generic, Literal, TypeGuard, cast
from opentelemetry.trace import Tracer
from typing_extensions import TypeVar, assert_never
from pydantic_ai._history_processor import HistoryProcessor
from pydantic_ai._instrumentation import DEFAULT_INSTRUMENTATION_VERSION
from pydantic_ai._tool_manager import ToolManager, ValidatedToolCall
from pydantic_ai._utils import dataclasses_no_defaults_repr, get_union_args, now_utc
from pydantic_ai.builtin_tools import AbstractBuiltinTool
from pydantic_ai.capabilities.abstract import AbstractCapability
from pydantic_ai.models import ModelRequestContext
from pydantic_graph import BaseNode, GraphRunContext
from pydantic_graph.beta import Graph, GraphBuilder
from pydantic_graph.nodes import End, NodeRunEndT
from . import _output, _system_prompt, exceptions, messages as _messages, models, result, usage as _usage
from ._run_context import set_current_run_context
from .exceptions import ToolRetryError
from .output import OutputDataT, OutputSpec
from .settings import ModelSettings
from .tools import (
AgentBuiltinTool,
DeferredToolCallResult,
DeferredToolResult,
DeferredToolResults,
RunContext,
ToolApproved,
ToolDefinition,
ToolDenied,
ToolKind,
)
if TYPE_CHECKING:
from datetime import datetime
from .models.instrumented import InstrumentationSettings
__all__ = (
'GraphAgentState',
'GraphAgentDeps',
'UserPromptNode',
'ModelRequestNode',
'CallToolsNode',
'build_run_context',
'capture_run_messages',
'HistoryProcessor',
)
T = TypeVar('T')
S = TypeVar('S')
NoneType = type(None)
EndStrategy = Literal['early', 'exhaustive']
DepsT = TypeVar('DepsT')
OutputT = TypeVar('OutputT')
@dataclasses.dataclass(kw_only=True)
class GraphAgentState:
"""State kept across the execution of the agent graph."""
message_history: list[_messages.ModelMessage] = dataclasses.field(default_factory=list[_messages.ModelMessage])
usage: _usage.RunUsage = dataclasses.field(default_factory=_usage.RunUsage)
retries: int = 0
run_step: int = 0
run_id: str = dataclasses.field(default_factory=lambda: str(uuid.uuid4()))
metadata: dict[str, Any] | None = None
last_max_tokens: int | None = None
"""Last-resolved `max_tokens` from model settings, used only in error messages."""
def increment_retries(
self,
max_result_retries: int,
error: BaseException | None = None,
) -> None:
self.retries += 1
if self.retries > max_result_retries:
if (
self.message_history
and isinstance(model_response := self.message_history[-1], _messages.ModelResponse)
and model_response.finish_reason == 'length'
and model_response.parts
and isinstance(tool_call := model_response.parts[-1], _messages.ToolCallPart)
):
try:
tool_call.args_as_dict(raise_if_invalid=True)
except Exception:
raise exceptions.IncompleteToolCall(
f'Model token limit ({self.last_max_tokens or "provider default"}) exceeded while generating a tool call, resulting in incomplete arguments. Increase the `max_tokens` model setting, or simplify the prompt to result in a shorter response that will fit within the limit.'
)
message = f'Exceeded maximum retries ({max_result_retries}) for output validation'
if error:
if isinstance(error, exceptions.UnexpectedModelBehavior) and error.__cause__ is not None:
error = error.__cause__
raise exceptions.UnexpectedModelBehavior(message) from error
else:
raise exceptions.UnexpectedModelBehavior(message)
@dataclasses.dataclass(kw_only=True)
class GraphAgentDeps(Generic[DepsT, OutputDataT]):
"""Dependencies/config passed to the agent graph."""
user_deps: DepsT
prompt: str | Sequence[_messages.UserContent] | None
new_message_index: int
resumed_request: _messages.ModelRequest | None
model: models.Model
get_model_settings: Callable[[RunContext[DepsT]], ModelSettings | None]
usage_limits: _usage.UsageLimits
max_result_retries: int
end_strategy: EndStrategy
get_instructions: Callable[[RunContext[DepsT]], Awaitable[str | None]]
output_schema: _output.OutputSchema[OutputDataT]
output_validators: list[_output.OutputValidator[DepsT, OutputDataT]]
validation_context: Any | Callable[[RunContext[DepsT]], Any]
root_capability: AbstractCapability[DepsT]
builtin_tools: list[AgentBuiltinTool[DepsT]] = dataclasses.field(repr=False)
tool_manager: ToolManager[DepsT]
tracer: Tracer
instrumentation_settings: InstrumentationSettings | None
class AgentNode(BaseNode[GraphAgentState, GraphAgentDeps[DepsT, Any], result.FinalResult[NodeRunEndT]]):
"""The base class for all agent nodes.
Using subclass of `BaseNode` for all nodes reduces the amount of boilerplate of generics everywhere
"""
def is_agent_node(
node: BaseNode[GraphAgentState, GraphAgentDeps[T, Any], result.FinalResult[S]] | End[result.FinalResult[S]],
) -> TypeGuard[AgentNode[T, S]]:
"""Check if the provided node is an instance of `AgentNode`.
Usage:
if is_agent_node(node):
# `node` is an AgentNode
...
This method preserves the generic parameters on the narrowed type, unlike `isinstance(node, AgentNode)`.
"""
return isinstance(node, AgentNode)
@dataclasses.dataclass
class UserPromptNode(AgentNode[DepsT, NodeRunEndT]):
"""The node that handles the user prompt and instructions."""
user_prompt: str | Sequence[_messages.UserContent] | None
_: dataclasses.KW_ONLY
deferred_tool_results: DeferredToolResults | None = None
instructions: str | None = None
instructions_functions: list[_system_prompt.SystemPromptRunner[DepsT]] = dataclasses.field(
default_factory=list[_system_prompt.SystemPromptRunner[DepsT]]
)
system_prompts: tuple[str, ...] = dataclasses.field(default_factory=tuple)
system_prompt_functions: list[_system_prompt.SystemPromptRunner[DepsT]] = dataclasses.field(
default_factory=list[_system_prompt.SystemPromptRunner[DepsT]]
)
system_prompt_dynamic_functions: dict[str, _system_prompt.SystemPromptRunner[DepsT]] = dataclasses.field(
default_factory=dict[str, _system_prompt.SystemPromptRunner[DepsT]]
)
async def run( # noqa: C901
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> ModelRequestNode[DepsT, NodeRunEndT] | CallToolsNode[DepsT, NodeRunEndT]:
try:
ctx_messages = get_captured_run_messages()
except LookupError:
messages: list[_messages.ModelMessage] = []
else:
if ctx_messages.used:
messages = []
else:
messages = ctx_messages.messages
ctx_messages.used = True
# Replace the `capture_run_messages` list with the message history
messages[:] = _clean_message_history(ctx.state.message_history)
# Use the `capture_run_messages` list as the message history so that new messages are added to it
ctx.state.message_history = messages
ctx.deps.new_message_index = len(messages)
if self.deferred_tool_results is not None:
return await self._handle_deferred_tool_results(self.deferred_tool_results, messages, ctx)
next_message: _messages.ModelRequest | None = None
is_resuming_without_prompt = False
run_context: RunContext[DepsT] | None = None
instructions: str | None = None
if messages and (last_message := messages[-1]):
if isinstance(last_message, _messages.ModelRequest) and self.user_prompt is None:
# Drop last message from history and reuse its parts
messages.pop()
next_message = _messages.ModelRequest(
parts=last_message.parts,
run_id=last_message.run_id,
metadata=last_message.metadata,
)
is_resuming_without_prompt = True
# Extract `UserPromptPart` content from the popped message and add to `ctx.deps.prompt`
user_prompt_parts = [part for part in last_message.parts if isinstance(part, _messages.UserPromptPart)]
if user_prompt_parts:
if len(user_prompt_parts) == 1:
ctx.deps.prompt = user_prompt_parts[0].content
else:
combined_content: list[_messages.UserContent] = []
for part in user_prompt_parts:
if isinstance(part.content, str):
combined_content.append(part.content)
else:
combined_content.extend(part.content)
ctx.deps.prompt = combined_content
elif isinstance(last_message, _messages.ModelResponse):
if self.user_prompt is None:
run_context = build_run_context(ctx)
instructions = await ctx.deps.get_instructions(run_context)
if not instructions:
# If there's no new prompt or instructions, skip ModelRequestNode and go directly to CallToolsNode
return CallToolsNode[DepsT, NodeRunEndT](last_message)
elif last_message.tool_calls:
raise exceptions.UserError(
'Cannot provide a new user prompt when the message history contains unprocessed tool calls.'
)
if not run_context:
run_context = build_run_context(ctx)
instructions = await ctx.deps.get_instructions(run_context)
if messages:
await self._reevaluate_dynamic_prompts(messages, run_context)
if next_message:
await self._reevaluate_dynamic_prompts([next_message], run_context)
else:
parts: list[_messages.ModelRequestPart] = []
if not messages:
parts.extend(await self._sys_parts(run_context))
if self.user_prompt is not None:
parts.append(_messages.UserPromptPart(self.user_prompt))
next_message = _messages.ModelRequest(parts=parts)
next_message.instructions = instructions
if not messages and not next_message.parts and not next_message.instructions:
raise exceptions.UserError('No message history, user prompt, or instructions provided')
return ModelRequestNode[DepsT, NodeRunEndT](
request=next_message, is_resuming_without_prompt=is_resuming_without_prompt
)
async def _handle_deferred_tool_results( # noqa: C901
self,
deferred_tool_results: DeferredToolResults,
messages: list[_messages.ModelMessage],
ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]],
) -> CallToolsNode[DepsT, NodeRunEndT]:
if not messages:
raise exceptions.UserError('Tool call results were provided, but the message history is empty.')
last_model_request: _messages.ModelRequest | None = None
last_model_response: _messages.ModelResponse | None = None
for message in reversed(messages):
if isinstance(message, _messages.ModelRequest):
last_model_request = message
elif isinstance(message, _messages.ModelResponse): # pragma: no branch
last_model_response = message
break
if not last_model_response:
raise exceptions.UserError(
'Tool call results were provided, but the message history does not contain a `ModelResponse`.'
)
if not last_model_response.tool_calls:
raise exceptions.UserError(
'Tool call results were provided, but the message history does not contain any unprocessed tool calls.'
)
tool_call_results: dict[str, DeferredToolResult | Literal['skip']] | None = None
tool_call_results = {}
for tool_call_id, approval in deferred_tool_results.approvals.items():
if approval is True:
approval = ToolApproved()
elif approval is False:
approval = ToolDenied()
tool_call_results[tool_call_id] = approval
if calls := deferred_tool_results.calls:
call_result_types = get_union_args(DeferredToolCallResult)
for tool_call_id, result in calls.items():
if not isinstance(result, call_result_types):
result = _messages.ToolReturn(result)
tool_call_results[tool_call_id] = result
if last_model_request:
for part in last_model_request.parts:
if isinstance(part, _messages.ToolReturnPart | _messages.RetryPromptPart):
if part.tool_call_id in tool_call_results:
raise exceptions.UserError(
f'Tool call {part.tool_call_id!r} was already executed and its result cannot be overridden.'
)
tool_call_results[part.tool_call_id] = 'skip'
# Skip ModelRequestNode and go directly to CallToolsNode
return CallToolsNode[DepsT, NodeRunEndT](
last_model_response,
tool_call_results=tool_call_results,
tool_call_metadata=deferred_tool_results.metadata or None,
user_prompt=self.user_prompt,
)
async def _reevaluate_dynamic_prompts(
self, messages: list[_messages.ModelMessage], run_context: RunContext[DepsT]
) -> None:
"""Reevaluate any `SystemPromptPart` with dynamic_ref in the provided messages by running the associated runner function."""
# Only proceed if there's at least one dynamic runner.
if self.system_prompt_dynamic_functions:
for msg in messages:
if isinstance(msg, _messages.ModelRequest):
reevaluated_message_parts: list[_messages.ModelRequestPart] = []
for part in msg.parts:
if isinstance(part, _messages.SystemPromptPart) and part.dynamic_ref:
# Look up the runner by its ref
if runner := self.system_prompt_dynamic_functions.get( # pragma: lax no cover
part.dynamic_ref
):
# To enable dynamic system prompt refs in future runs, use a placeholder string
updated_part_content = await runner.run(run_context)
part = _messages.SystemPromptPart(
updated_part_content or '', dynamic_ref=part.dynamic_ref
)
reevaluated_message_parts.append(part)
# Replace message parts with reevaluated ones to prevent mutating parts list
if reevaluated_message_parts != msg.parts:
msg.parts = reevaluated_message_parts
async def _sys_parts(self, run_context: RunContext[DepsT]) -> list[_messages.ModelRequestPart]:
"""Build the initial messages for the conversation."""
messages: list[_messages.ModelRequestPart] = [_messages.SystemPromptPart(p) for p in self.system_prompts]
for sys_prompt_runner in self.system_prompt_functions:
prompt = await sys_prompt_runner.run(run_context)
if sys_prompt_runner.dynamic:
# To enable dynamic system prompt refs in future runs, use a placeholder string
messages.append(
_messages.SystemPromptPart(prompt or '', dynamic_ref=sys_prompt_runner.function.__qualname__)
)
elif prompt:
# omit empty system prompts
messages.append(_messages.SystemPromptPart(prompt))
return messages
__repr__ = dataclasses_no_defaults_repr
async def _prepare_request_parameters(
ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]],
) -> models.ModelRequestParameters:
"""Build tools and create an agent model."""
output_schema = ctx.deps.output_schema
prompted_output_template = (
output_schema.template if isinstance(output_schema, _output.StructuredTextOutputSchema) else None
)
all_tool_defs = list(ctx.deps.tool_manager.tool_defs)
# Let capabilities filter/modify tool definitions
run_context = build_run_context(ctx)
all_tool_defs = await ctx.deps.root_capability.prepare_tools(run_context, all_tool_defs)
function_tools: list[ToolDefinition] = []
output_tools: list[ToolDefinition] = []
for tool_def in all_tool_defs:
if tool_def.kind == 'output':
output_tools.append(tool_def)
else:
function_tools.append(tool_def)
# resolve dynamic builtin tools
builtin_tools: list[AbstractBuiltinTool] = []
if ctx.deps.builtin_tools:
for tool in ctx.deps.builtin_tools:
if isinstance(tool, AbstractBuiltinTool):
builtin_tools.append(tool)
else:
t = tool(run_context)
if inspect.isawaitable(t):
t = await t
if t is not None:
builtin_tools.append(t)
return models.ModelRequestParameters(
function_tools=function_tools,
builtin_tools=builtin_tools,
output_mode=output_schema.mode,
output_tools=output_tools,
output_object=output_schema.object_def,
prompted_output_template=prompted_output_template,
allow_text_output=output_schema.allows_text,
allow_image_output=output_schema.allows_image,
)
@dataclasses.dataclass
class _SkipStreamedResponse(models.StreamedResponse):
"""Minimal StreamedResponse for SkipModelRequest — yields no events.
These properties implement the StreamedResponse ABC but are never accessed:
the streaming skip path always resolves via the _run_result shortcut in
StreamedRunResult, so the AgentStream wrapping this response is discarded.
"""
_response: _messages.ModelResponse = field(repr=False)
@property
def model_name(self) -> str: # pragma: no cover
return self._response.model_name or ''
@property
def provider_name(self) -> str | None: # pragma: no cover
return None
@property
def provider_url(self) -> str | None: # pragma: no cover
return None
@property
def timestamp(self) -> datetime: # pragma: no cover
return self._response.timestamp
async def _get_event_iterator(self) -> AsyncIterator[_messages.ModelResponseStreamEvent]:
return
yield # pragma: no cover
def get(self) -> _messages.ModelResponse: # pragma: no cover
return self._response
@dataclasses.dataclass
class ModelRequestNode(AgentNode[DepsT, NodeRunEndT]):
"""The node that makes a request to the model using the last message in state.message_history."""
request: _messages.ModelRequest
is_resuming_without_prompt: bool = False
_result: CallToolsNode[DepsT, NodeRunEndT] | ModelRequestNode[DepsT, NodeRunEndT] | None = field(
repr=False, init=False, default=None
)
_did_stream: bool = field(repr=False, init=False, default=False)
last_request_context: ModelRequestContext | None = field(repr=False, init=False, default=None)
async def run(
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> CallToolsNode[DepsT, NodeRunEndT] | ModelRequestNode[DepsT, NodeRunEndT]:
if self._result is not None:
return self._result
if self._did_stream:
# `self._result` gets set when exiting the `stream` contextmanager, so hitting this
# means that the stream was started but not finished before `run()` was called
raise exceptions.AgentRunError('You must finish streaming before calling run()') # pragma: no cover
return await self._make_request(ctx)
@asynccontextmanager
async def stream(
self,
ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, T]],
) -> AsyncIterator[result.AgentStream[DepsT, T]]:
assert not self._did_stream, 'stream() should only be called once per node'
try:
model_settings, model_request_parameters, message_history, run_context = await self._prepare_request(ctx)
except exceptions.SkipModelRequest as e:
# SkipModelRequest in stream path: yield an empty stream and finish handling
# new_message_index wasn't updated in _prepare_request, fix it here
ctx.deps.new_message_index = _first_new_message_index(
ctx.state.message_history, ctx.state.run_id, resumed_request=ctx.deps.resumed_request
)
self._did_stream = True
ctx.state.usage.requests += 1
skip_mrp = await _prepare_request_parameters(ctx)
skip_sr = _SkipStreamedResponse(model_request_parameters=skip_mrp, _response=e.response)
agent_stream = self._build_agent_stream(ctx, skip_sr, skip_mrp)
yield agent_stream
await self._finish_handling(ctx, e.response)
assert self._result is not None
return
# Cooperative hand-off between this coroutine and the wrap_model_request task:
# 1. The task runs capability middleware, then calls _streaming_handler which opens the stream.
# 2. _streaming_handler sets stream_ready once the stream is open, then waits on stream_done.
# 3. This coroutine waits for stream_ready (or early task completion), yields the stream
# to the caller, and sets stream_done when the caller is finished consuming it.
# 4. The handler resumes, the stream context manager closes, and the task completes.
stream_ready = asyncio.Event()
stream_done = asyncio.Event()
agent_stream_holder: list[result.AgentStream[DepsT, T]] = []
async def _streaming_handler(
req_ctx: ModelRequestContext,
) -> _messages.ModelResponse:
with set_current_run_context(run_context):
async with ctx.deps.model.request_stream(
req_ctx.messages, req_ctx.model_settings, req_ctx.model_request_parameters, run_context
) as sr:
self._did_stream = True
ctx.state.usage.requests += 1
agent_stream = self._build_agent_stream(ctx, sr, req_ctx.model_request_parameters)
agent_stream_holder.append(agent_stream)
stream_ready.set()
await stream_done.wait()
return sr.get()
wrap_request_context = ModelRequestContext(
messages=message_history,
model_settings=model_settings,
model_request_parameters=model_request_parameters,
)
wrap_task = asyncio.create_task(
ctx.deps.root_capability.wrap_model_request(
run_context,
request_context=wrap_request_context,
handler=_streaming_handler,
)
)
# Wait for handler to start or wrap to complete (short-circuit)
ready_waiter = asyncio.create_task(stream_ready.wait())
await asyncio.wait({ready_waiter, wrap_task}, return_when=asyncio.FIRST_COMPLETED)
ready_waiter.cancel()
if wrap_task.done() and not stream_ready.is_set():
# wrap_model_request completed without calling handler — short-circuited or raised SkipModelRequest
try:
try:
model_response = wrap_task.result()
except exceptions.SkipModelRequest as e:
model_response = e.response
except exceptions.ModelRetry:
raise # Propagate to outer handler
except Exception as e:
model_response = await ctx.deps.root_capability.on_model_request_error(
run_context, request_context=wrap_request_context, error=e
)
except exceptions.ModelRetry as e:
self._did_stream = True
ctx.state.usage.requests += 1
ctx.state.increment_retries(ctx.deps.max_result_retries, error=e)
m = _messages.RetryPromptPart(content=e.message)
instructions = await ctx.deps.get_instructions(run_context)
self._result = ModelRequestNode(_messages.ModelRequest(parts=[m], instructions=instructions))
return
self._did_stream = True
ctx.state.usage.requests += 1
skip_sr = _SkipStreamedResponse(model_request_parameters=model_request_parameters, _response=model_response)
agent_stream = self._build_agent_stream(ctx, skip_sr, model_request_parameters)
yield agent_stream
await self._finish_handling(ctx, model_response)
assert self._result is not None
return
# Normal path: handler was called, stream is ready
stream_error: BaseException | None = None
try:
yield agent_stream_holder[0]
# Ensure stream is fully consumed for proper usage counting
async for _ in agent_stream_holder[0]:
pass
except BaseException as exc:
stream_error = exc
raise
finally:
stream_done.set()
if stream_error is not None:
wrap_task.cancel()
try:
await wrap_task
except (asyncio.CancelledError, BaseException):
pass
else:
try:
try:
model_response = await wrap_task
except exceptions.ModelRetry:
raise # Propagate to outer handler
except Exception as e:
model_response = await ctx.deps.root_capability.on_model_request_error(
run_context, request_context=wrap_request_context, error=e
)
except exceptions.ModelRetry as e:
ctx.state.usage.requests += 1
ctx.state.increment_retries(ctx.deps.max_result_retries, error=e)
m = _messages.RetryPromptPart(content=e.message)
instructions = await ctx.deps.get_instructions(run_context)
self._result = ModelRequestNode(_messages.ModelRequest(parts=[m], instructions=instructions))
return
await self._finish_handling(ctx, model_response)
assert self._result is not None
@staticmethod
def _build_agent_stream(
ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, T]],
stream_response: models.StreamedResponse,
model_request_parameters: models.ModelRequestParameters,
) -> result.AgentStream[DepsT, T]:
"""Build an AgentStream from the given stream response and context."""
return result.AgentStream[DepsT, T](
_raw_stream_response=stream_response,
_output_schema=ctx.deps.output_schema,
_model_request_parameters=model_request_parameters,
_output_validators=ctx.deps.output_validators,
_run_ctx=build_run_context(ctx),
_usage_limits=ctx.deps.usage_limits,
_tool_manager=ctx.deps.tool_manager,
_metadata_getter=lambda: ctx.state.metadata,
)
async def _make_request(
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> CallToolsNode[DepsT, NodeRunEndT] | ModelRequestNode[DepsT, NodeRunEndT]:
if self._result is not None:
return self._result # pragma: no cover
try:
model_settings, model_request_parameters, message_history, run_context = await self._prepare_request(ctx)
except exceptions.SkipModelRequest as e:
# new_message_index wasn't updated in _prepare_request, fix it here
ctx.deps.new_message_index = _first_new_message_index(
ctx.state.message_history, ctx.state.run_id, resumed_request=ctx.deps.resumed_request
)
ctx.state.usage.requests += 1
return await self._finish_handling(ctx, e.response)
async def model_handler(req_ctx: ModelRequestContext) -> _messages.ModelResponse:
with set_current_run_context(run_context):
return await ctx.deps.model.request(
req_ctx.messages, req_ctx.model_settings, req_ctx.model_request_parameters
)
request_context = ModelRequestContext(
messages=message_history,
model_settings=model_settings,
model_request_parameters=model_request_parameters,
)
try:
try:
model_response = await ctx.deps.root_capability.wrap_model_request(
run_context,
request_context=request_context,
handler=model_handler,
)
except exceptions.SkipModelRequest as e:
model_response = e.response
except exceptions.ModelRetry:
raise # Propagate to outer handler
except Exception as e:
model_response = await ctx.deps.root_capability.on_model_request_error(
run_context, request_context=request_context, error=e
)
except exceptions.ModelRetry as e:
# ModelRetry from wrap_model_request or on_model_request_error — retry the model request.
# No model response to append (handler may not have been called).
ctx.state.usage.requests += 1
ctx.state.increment_retries(ctx.deps.max_result_retries, error=e)
m = _messages.RetryPromptPart(content=e.message)
instructions = await ctx.deps.get_instructions(run_context)
retry_node = ModelRequestNode[DepsT, NodeRunEndT](
_messages.ModelRequest(parts=[m], instructions=instructions)
)
self._result = retry_node
return retry_node
ctx.state.usage.requests += 1
return await self._finish_handling(ctx, model_response)
async def _prepare_request(
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> tuple[ModelSettings | None, models.ModelRequestParameters, list[_messages.ModelMessage], RunContext[DepsT]]:
self.request.timestamp = now_utc()
if not self.is_resuming_without_prompt:
self.request.run_id = self.request.run_id or ctx.state.run_id
ctx.state.message_history.append(self.request)
ctx.state.run_step += 1
run_context = build_run_context(ctx)
# This will raise errors for any tool name conflicts
ctx.deps.tool_manager = await ctx.deps.tool_manager.for_run_step(run_context)
model_request_parameters = await _prepare_request_parameters(ctx)
model_settings = ctx.deps.get_model_settings(run_context) or ModelSettings()
run_context.model_settings = model_settings
request_context = ModelRequestContext(
messages=ctx.state.message_history[:],
model_settings=model_settings,
model_request_parameters=model_request_parameters,
)
self.last_request_context = request_context
request_context = await ctx.deps.root_capability.before_model_request(
run_context,
request_context,
)
self.last_request_context = request_context
messages = request_context.messages
model_settings = request_context.model_settings
model_request_parameters = request_context.model_request_parameters
if len(messages) == 0:
raise exceptions.UserError('Processed history cannot be empty.')
if not isinstance(messages[-1], _messages.ModelRequest):
raise exceptions.UserError('Processed history must end with a `ModelRequest`.')
# Ensure the last request has a timestamp (history processors may create new ModelRequest objects without one)
if messages[-1].timestamp is None:
messages[-1].timestamp = now_utc()
if messages and messages[-1].run_id is None:
messages[-1].run_id = ctx.state.run_id
if self.is_resuming_without_prompt:
ctx.deps.resumed_request = self.request
# `ctx.state.message_history` is the same list used by `capture_run_messages`, so we should replace its contents, not the reference
ctx.state.message_history[:] = messages
# Update the new message index to ensure `result.new_messages()` returns the correct messages
ctx.deps.new_message_index = _first_new_message_index(
messages, ctx.state.run_id, resumed_request=ctx.deps.resumed_request
)
# Merge possible consecutive trailing `ModelRequest`s into one, with tool call parts before user parts,
# but don't store it in the message history on state. This is just for the benefit of model classes that want clear user/assistant boundaries.
# See `tests/test_tools.py::test_parallel_tool_return_with_deferred` for an example where this is necessary
messages = _clean_message_history(messages)
ctx.state.last_max_tokens = model_settings.get('max_tokens') if model_settings else None
usage = ctx.state.usage
if ctx.deps.usage_limits.count_tokens_before_request:
# Copy to avoid modifying the original usage object with the counted usage
usage = deepcopy(usage)
counted_usage = await ctx.deps.model.count_tokens(messages, model_settings, model_request_parameters)
usage.incr(counted_usage)
ctx.deps.usage_limits.check_before_request(usage)
return model_settings or None, model_request_parameters, messages, run_context
async def _finish_handling(
self,
ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]],
response: _messages.ModelResponse,
) -> CallToolsNode[DepsT, NodeRunEndT] | ModelRequestNode[DepsT, NodeRunEndT]:
response.run_id = response.run_id or ctx.state.run_id
run_context = build_run_context(ctx)
assert self.last_request_context is not None, 'last_request_context must be set before _finish_handling'
request_context = self.last_request_context
run_context.model_settings = request_context.model_settings
try:
response = await ctx.deps.root_capability.after_model_request(
run_context, request_context=request_context, response=response
)
except exceptions.ModelRetry as e:
# Hook rejected the response — append it to history (model DID respond) and retry
ctx.state.usage.incr(response.usage)
if ctx.deps.usage_limits: # pragma: no branch
ctx.deps.usage_limits.check_tokens(ctx.state.usage)
ctx.state.message_history.append(response)
ctx.state.increment_retries(ctx.deps.max_result_retries, error=e)
m = _messages.RetryPromptPart(content=e.message)
instructions = await ctx.deps.get_instructions(run_context)
retry_node = ModelRequestNode[DepsT, NodeRunEndT](
_messages.ModelRequest(parts=[m], instructions=instructions)
)
self._result = retry_node
return retry_node
# Update usage
ctx.state.usage.incr(response.usage)
if ctx.deps.usage_limits: # pragma: no branch
ctx.deps.usage_limits.check_tokens(ctx.state.usage)
# Append the model response to state.message_history
ctx.state.message_history.append(response)
# Set the `_result` attribute since we can't use `return` in an async iterator
self._result = CallToolsNode(response)
return self._result
__repr__ = dataclasses_no_defaults_repr
@dataclasses.dataclass
class CallToolsNode(AgentNode[DepsT, NodeRunEndT]):
"""The node that processes a model response, and decides whether to end the run or make a new request."""
model_response: _messages.ModelResponse
tool_call_results: dict[str, DeferredToolResult | Literal['skip']] | None = None
tool_call_metadata: dict[str, dict[str, Any]] | None = None
"""Metadata for deferred tool calls, keyed by `tool_call_id`."""
user_prompt: str | Sequence[_messages.UserContent] | None = None
"""Optional user prompt to include alongside tool call results.
This prompt is only sent to the model when the `model_response` contains tool calls.
If the `model_response` has final output instead, this user prompt is ignored.
The user prompt will be appended after all tool return parts in the next model request.
"""
_events_iterator: AsyncIterator[_messages.HandleResponseEvent] | None = field(default=None, init=False, repr=False)
_next_node: ModelRequestNode[DepsT, NodeRunEndT] | End[result.FinalResult[NodeRunEndT]] | None = field(
default=None, init=False, repr=False
)
async def run(
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> ModelRequestNode[DepsT, NodeRunEndT] | End[result.FinalResult[NodeRunEndT]]:
async with self.stream(ctx):
pass
assert self._next_node is not None, 'the stream should set `self._next_node` before it ends'
return self._next_node
@asynccontextmanager
async def stream(
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> AsyncIterator[AsyncIterator[_messages.HandleResponseEvent]]:
"""Process the model response and yield events for the start and end of each function tool call."""
stream = self._run_stream(ctx)
yield stream
# Run the stream to completion if it was not finished:
async for _event in stream:
pass
async def _run_stream( # noqa: C901
self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
) -> AsyncIterator[_messages.HandleResponseEvent]:
if self._events_iterator is None:
# Ensure that the stream is only run once
output_schema = ctx.deps.output_schema
async def _run_stream() -> AsyncIterator[_messages.HandleResponseEvent]: # noqa: C901
is_empty = not self.model_response.parts
is_thinking_only = not is_empty and all(
isinstance(p, _messages.ThinkingPart) for p in self.model_response.parts
)
if is_empty or is_thinking_only:
# No actionable output was returned by the model.
# Don't retry if the token limit was exceeded, possibly during thinking.
if self.model_response.finish_reason == 'length':
raise exceptions.UnexpectedModelBehavior(
f'Model token limit ({ctx.state.last_max_tokens or "provider default"}) exceeded before any response was generated. Increase the `max_tokens` model setting, or simplify the prompt to result in a shorter response that will fit within the limit.'
)
# Check for content filter on empty response
if is_empty and self.model_response.finish_reason == 'content_filter':
details = self.model_response.provider_details or {}
body = _messages.ModelMessagesTypeAdapter.dump_json([self.model_response]).decode()
if reason := details.get('finish_reason'):
message = f"Content filter triggered. Finish reason: '{reason}'"
elif reason := details.get('block_reason'):
message = f"Content filter triggered. Block reason: '{reason}'"
elif refusal := details.get('refusal'):
message = f'Content filter triggered. Refusal: {refusal!r}'
else: # pragma: no cover
message = 'Content filter triggered.'
raise exceptions.ContentFilterError(message, body=body)
# Try to recover text from a previous model response.
# This handles the case where the model returned text alongside tool calls
# (so the text was discarded in favor of executing the tools) and subsequently
# returned an empty or thinking-only response.
if text_processor := output_schema.text_processor:
text = self._recover_text_from_message_history(ctx.state.message_history)
if text is not None:
try:
self._next_node = await self._handle_text_response(ctx, text, text_processor)
return
except ToolRetryError: # pragma: no cover
# If the recovered text was invalid, fall through.
pass
if is_empty:
# Go back to the model request node with an empty request, which means we'll
# essentially resubmit the most recent request that resulted in an empty response,
# as the empty response and request will not create any items in the API payload,
# in the hope the model will return a non-empty response this time.
ctx.state.increment_retries(ctx.deps.max_result_retries)
run_context = build_run_context(ctx)
instructions = await ctx.deps.get_instructions(run_context)
self._next_node = ModelRequestNode[DepsT, NodeRunEndT](
_messages.ModelRequest(parts=[], instructions=instructions)
)
return
# For thinking-only responses without recoverable text, fall through to the
# normal retry prompt below.
text = ''
tool_calls: list[_messages.ToolCallPart] = []
files: list[_messages.BinaryContent] = []
for part in self.model_response.parts:
if isinstance(part, _messages.TextPart):
text += part.content
elif isinstance(part, _messages.ToolCallPart):
tool_calls.append(part)
elif isinstance(part, _messages.FilePart):
files.append(part.content)
elif isinstance(part, _messages.BuiltinToolCallPart):
# Text parts before a built-in tool call are essentially thoughts,
# not part of the final result output, so we reset the accumulated text
text = ''
yield _messages.BuiltinToolCallEvent(part) # pyright: ignore[reportDeprecated]
elif isinstance(part, _messages.BuiltinToolReturnPart):
yield _messages.BuiltinToolResultEvent(part) # pyright: ignore[reportDeprecated]
elif isinstance(part, _messages.ThinkingPart):
pass
else:
assert_never(part)
try:
# At the moment, we prioritize at least executing tool calls if they are present.
# In the future, we'd consider making this configurable at the agent or run level.
# This accounts for cases like anthropic returns that might contain a text response
# and a tool call response, where the text response just indicates the tool call will happen.
alternatives: list[str] = []
if tool_calls:
async for event in self._handle_tool_calls(ctx, tool_calls):
yield event
return
elif output_schema.toolset:
alternatives.append('include your response in a tool call')
elif ctx.deps.tool_manager.tools is None or ctx.deps.tool_manager.tools:
# tools is None when the tool manager is unprepared (e.g. UserPromptNode
# skips to CallToolsNode, bypassing for_run_step); in that case we
# default to suggesting tools to be safe
alternatives.append('call a tool')
if output_schema.allows_image:
if image := next((file for file in files if isinstance(file, _messages.BinaryImage)), None):
self._next_node = await self._handle_image_response(ctx, image)
return
alternatives.append('return an image')
if text_processor := output_schema.text_processor:
if text:
self._next_node = await self._handle_text_response(ctx, text, text_processor)
return
alternatives.insert(0, 'return text')
# handle responses with only parts that don't constitute output.
# This can happen with models that support thinking mode when they don't provide
# actionable output alongside their thinking content. so we tell the model to try again.
m = _messages.RetryPromptPart(
content=f'Please {" or ".join(alternatives)}.',
)
raise ToolRetryError(m)