feat: adds structured output docs #86
Open
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
This pull request introduces a new feature, "Structured Output," to the documentation, providing a detailed explanation of how to use Pydantic models for type-safe, validated responses from language models. Additionally, it updates the API reference to include this feature. The most important changes are grouped below by theme.
Ref: strands-agents/sdk-python#60
Documentation Updates
API Reference Update: Added
strands.agent.agent.structured_output
to the API reference indocs/api-reference/agent.md
, ensuring the new feature is documented alongside existing functionalities.Structured Output Guide: Added a comprehensive guide in
docs/user-guide/concepts/agents/structured-output.md
explaining the "Structured Output" feature, including its benefits, how it works, usage patterns, advanced features, and best practices. The guide includes code examples for defining Pydantic models, integrating with agents, handling errors, and leveraging structured output in workflows.Type of Change
Motivation and Context
Reflects the addition of structured output
Screenshots
Checklist
mkdocs serve
Additional Notes
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.