Fix #2102: Add structured response token counting examples #2133
+54
−1
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
This PR adds comprehensive examples for counting tokens when using structured responses with the
response_format
parameter, addressing the gap identified in issue #2102.Changes
Added a new section (Section 8) to the tiktoken notebook that covers:
response_format={"type": "json_object"}
)num_tokens_for_structured_response()
to calculate schema overheadImplementation Details
The solution introduces:
Testing
All code examples have been tested to ensure:
Impact
This enhancement helps developers:
Fixes #2102