Skip to content

feat: adds structured output docs #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

theagenticguy
Copy link

@theagenticguy theagenticguy commented Jun 8, 2025

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 in docs/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

  • New content addition

Motivation and Context

Reflects the addition of structured output

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • Links in the documentation are valid and working
  • Images/diagrams are properly sized and formatted
  • All new and existing tests pass

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant