docs: add completion receipt example#965
Open
aDragon0707 wants to merge 1 commit into
Open
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
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.
Summary
Adds a small example showing how to request a structured completion receipt from the Python SDK.
The example uses the existing
ClaudeAgentOptions.output_formatJSON schema support and reads the receipt fromResultMessage.structured_output. It separates:Motivation
Agent final answers can include operational claims such as task completed, tests passed, branch ready to merge, or deployment ready.
Those claims may need evidence from tool outputs, logs, traces, file diffs, command output, or human approval before a workflow treats the task as complete.
This example keeps the receipt as typed structured output rather than requiring downstream code to parse free-form final text.
Notes
Verification
python -m py_compile examples/completion_receipt.pygit diff --check --cachedpython -m ruff check examples/completion_receipt.pybecauseruffis not installed in this local environment.