Add usage guidance for structured_output behaviour #261
+7
−1
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
zastrowm
requested changes
Sep 22, 2025
| Then use the `Agent.structured_output()` method as shown in the following sections. | ||
|
|
||
| > #### Note on Usage | ||
| > Using `structured_ouput` creates a tool with the same name as the Pydantic model you have defined, say - "SomePydanticModel". |
There was a problem hiding this comment.
This is only true for some providers - others use the model's API for structured output.
For the providers that do use a tool - the only tool available is the PydanticModel tool and now it's forced used so the model doesn't even have a choice.
|
@zastrowm could you take another look? |
zastrowm
approved these changes
Oct 1, 2025
|
We need @afarntrog 's review to close this as well, I believe. |
afarntrog
approved these changes
Oct 3, 2025
| Then use the `Agent.structured_output()` method: | ||
| Then use the `Agent.structured_output()` method as shown in the following sections. | ||
|
|
||
| > #### Note on Usage |
There was a problem hiding this comment.
consider using the following format for the note instead:
!!! note "Note on Usage"
text here...
This will render it with a note background and icon like we elsewhere. For example: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#changing-the-title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Added usage guidance on a commonly observed misunderstanding about "structured_output". Customers usually expect to be able to use "structured_output" to continue conversations like regular agent prompts, however tool use apart from the Pydantic model tool cause errors
Type of Change
Motivation and Context
Primarily provides more clarity on the intended usage as called out here -
309, 872
Improves customer expectation for short-term, while changes like strands-agents/sdk-python#891 can potentially solve for long term.
Areas Affected
Description of structured_output
Screenshots
Checklist
mkdocs serveAdditional Notes
None
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.