-
Couldn't load subscription status.
- Fork 11.5k
Fix #2102: Add structured response token counting examples #2133
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
jalateras
wants to merge
1
commit into
openai:main
from
jalateras:add-structured-response-token-counting
Open
Fix #2102: Add structured response token counting examples #2133
jalateras
wants to merge
1
commit into
openai:main
from
jalateras:add-structured-response-token-counting
+54
−1
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
...ebook Added comprehensive examples for counting tokens when using structured outputs: - JSON mode token counting with minimal overhead estimation - Structured output with JSON schema token counting - Comparison of token usage across different response formats - Helper function to calculate schema overhead for accurate cost estimation This addresses the need for understanding token usage with response_format parameter, helping developers better estimate costs and manage context windows when using structured outputs. Fixes openai#2102
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
This PR adds comprehensive examples for counting tokens when using structured responses with the
response_formatparameter, 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