docs(examples): add structured output example #827
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.
Summary
Adds a comprehensive example demonstrating how to produce structured JSON output using the
tool_choiceparameter. This addresses the documentation request in #816.What This PR Does
examples/structured-output.tswith two complete examples:Key Feature Demonstrated
The critical pattern that enables structured output:
By defining a tool with the desired JSON schema and forcing its use via
tool_choice, Claude returns guaranteed structured output matching the schema.Examples Included
Additional Changes
The repository's formatter made minor whitespace improvements to:
.github/workflows/create-releases.yml.github/workflows/release-docker.ymlbin/cliThese are cosmetic-only changes that improve consistency.
Documentation
The example includes:
Fixes #816
Note: This example demonstrates the workaround pattern mentioned in the issue, as the Anthropic API currently doesn't provide a first-class structured output feature. The
tool_choiceapproach is the recommended method per the issue discussion.