Token truncation handling #2003
Draft
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.
feat: add truncation-aware retry handling with failfast and auto-ramp
Describe your changes
This enhancement introduces two new parameters to improve how Instructor handles model response truncation:
failfast_on_truncation=True: When enabled, Instructor will immediately raise anIncompleteOutputExceptionif a model's response is truncated due tomax_tokenslimits. This prevents wasted validation retries when the issue is insufficient output length, not malformed JSON.max_tokens_auto_ramp: This option allows Instructor to automatically increase themax_tokens(or equivalent model-specific token limits likemax_output_tokens,maxTokens) for subsequent retries when truncation is detected. It's configurable with amultiplier, an optionalcap, andmax_attemptsto control the ramping behavior. This addresses truncation by increasing the token budget only when needed, optimizing rate limits and concurrency.These features are integrated into the
instructor.patchfunction and theInstructorclient'screatemethods, and are supported by updated documentation and new unit tests.Issue ticket number and link
567-252, #1962
Checklist before requesting a review
Linear Issue: 567-252