Skip to content

Update structured output docs to make tool use example more obvious #191

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 2 commits into
base: main
Choose a base branch
from

Conversation

Unshure
Copy link
Member

@Unshure Unshure commented Jul 30, 2025

Description

Update the structured output docs to make the example for tool use in structured output more obvious.

Type of Change

  • Structure/organization improvement

Motivation and Context

Many customers have run into confusion using structured output

Areas Affected

strucutred output

Screenshots

https://unshure.github.io/docs/0.3.x/user-guide/concepts/agents/structured-output/#using-tools-and-conversation-history

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

A follow up feature addition to structured output will be made to improve the UX here

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dbschmigelski dbschmigelski changed the title Update strucutred output docs to make tool use exmaple more obvious Update structured output docs to make tool use example more obvious Jul 30, 2025
@@ -78,6 +78,34 @@ print(f"Age: {result.age}") # 30
print(f"Job: {result.occupation}") # "software engineer"
```

### Using Tools and Conversation History

Structured output can work with tools and conversation history, but the agent must be primed with that information before calling the `strucutred_output` function.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: typo strucutred_output
Other than that lgtm

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.

2 participants