Update docs about choosing final_result in sync and stream modes
#3725
+19
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Danipulok
commented
Dec 14, 2025
| `run_stream()` behaves differently from `run()` and `run_sync()` when choosing the final result: | ||
|
|
||
| - **`run_stream()`**: The first called tool that **can** produce a final result (output or deferred) becomes the final result | ||
| - **`run()` / `run_sync()`**: The first **output** tool becomes the final result. If none are called, all **deferred** tools become the final result as `DeferredToolRequests` |
Contributor
Author
There was a problem hiding this comment.
If none are called
The wording is like this, since we get an UnexpectedModelBehavior if both output and deferred tools are called, but none output tools are validated
Contributor
Author
There was a problem hiding this comment.
If I understand correctly, the deferred tools args are not validated
I guess it means we could check that if any deferred tools calls are present and tool_call_results is None, we can skip ignore invalid output tool calls, as we do in here:
pydantic-ai/pydantic_ai_slim/pydantic_ai/_agent_graph.py
Lines 913 to 915 in ccefddc
But I'm not sure about it...
And IMHO, if do this at all, then it should be done in a separate PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3636