docs: replace deprecated validation_context with context parameter#1831
Merged
docs: replace deprecated validation_context with context parameter#1831
Conversation
- Update all code examples to use context= instead of validation_context= - Update prose and comments to reference the new parameter name - validation_context is deprecated in favor of the simpler context parameter Files updated: - docs/llms.txt - docs/examples/exact_citations.md - docs/examples/bulk_classification.md - docs/examples/youtube_clips.md - docs/blog/posts/version-1.md - docs/blog/posts/validation-part1.md - docs/prompting/ensembling/universal_self_consistency.md - docs/concepts/hooks.md - docs/concepts/patching.md Co-Authored-By: Jason Liu <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
There was a problem hiding this comment.
Caution
Changes requested ❌
Reviewed everything up to 18136bf in 2 minutes and 5 seconds. Click for details.
- Reviewed
183lines of code in9files - Skipped
0files when reviewing. - Skipped posting
10draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/blog/posts/validation-part1.md:410
- Draft comment:
Good update – replacedvalidation_contextwithcontextin the explanation for how context is passed to validator functions. Changes are clear and consistent. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply acknowledges a change that was made, which violates the rule against making purely informative comments.
2. docs/concepts/hooks.md:15
- Draft comment:
The hook documentation now correctly mentions thecontextparameter. Looks clear and consistent. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative and does not provide any actionable feedback or suggestions. It simply states that the documentation looks clear and consistent, which is not necessary for the PR author to know.
3. docs/concepts/patching.md:13
- Draft comment:
Replacedvalidation_contextwithcontextin the list of added parameters – this aligns documentation with current API usage. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative, explaining a change made to align documentation with current API usage. It doesn't provide a suggestion, ask for confirmation, or highlight a potential issue. According to the rules, purely informative comments should be removed.
4. docs/examples/bulk_classification.md:173
- Draft comment:
Good change – all instances ofvalidation_contextreplaced withcontextin async classification examples. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative, as it just acknowledges a change without providing any actionable feedback or suggestions. It does not align with the rules for useful comments.
5. docs/examples/exact_citations.md:113
- Draft comment:
Updated the comment and parameter name to usecontextinstead ofvalidation_context. Documentation is now consistent. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative, stating that a comment and parameter name were updated for consistency. It doesn't provide any actionable feedback or suggestions for improvement.
6. docs/examples/youtube_clips.md:86
- Draft comment:
Replaced usage ofvalidation_contextwithcontextin the sample call. The change is clear and consistent with other examples. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative, stating what was changed without providing any actionable feedback or suggestions. It doesn't ask for confirmation or suggest improvements.
7. docs/llms.txt:885
- Draft comment:
Updated text and code from usingvalidation_contexttocontext. This helps maintain consistency across documentation. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative and does not provide any actionable feedback or suggestions. It simply states what was changed and why, which is not necessary for a code review comment.
8. docs/prompting/ensembling/universal_self_consistency.md:91
- Draft comment:
The self-consistency example now usescontext(e.g., passing number_responses) correctly in the validation. Looks good overall. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold85%This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states that the example now usescontextcorrectly, which does not align with the rules provided.
9. docs/blog/posts/validation-part1.md:439
- Draft comment:
Typographical suggestion: Consider hyphenating "self correct" to "self-correct" for clarity. - Reason this comment was not posted:
Comment was on unchanged code.
10. docs/blog/posts/version-1.md:22
- Draft comment:
Typo: "isntructor" should be corrected to "instructor". - Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_jHc3stTrligXQfjD
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
| # Announcing instructor=1.0.0 | ||
|
|
||
| Over the past 10 months, we've build up instructor with the [principle](../../why.md) of 'easy to try, and easy to delete'. We accomplished this by patching the openai client with the `instructor` package and adding new arguments like `response_model`, `max_retries`, and `validation_context`. As a result I truly believe isntructor is the [best way](./best_framework.md) to get structured data out of llm apis. | ||
| Over the past 10 months, we've build up instructor with the [principle](../../why.md) of 'easy to try, and easy to delete'. We accomplished this by patching the openai client with the `instructor` package and adding new arguments like `response_model`, `max_retries`, and `context`. As a result I truly believe isntructor is the [best way](./best_framework.md) to get structured data out of llm apis. |
Contributor
There was a problem hiding this comment.
Updated text to refer to context instead of validation_context. Also note a minor typo: "isntructor" should be corrected to "instructor".
Suggested change
| Over the past 10 months, we've build up instructor with the [principle](../../why.md) of 'easy to try, and easy to delete'. We accomplished this by patching the openai client with the `instructor` package and adding new arguments like `response_model`, `max_retries`, and `context`. As a result I truly believe isntructor is the [best way](./best_framework.md) to get structured data out of llm apis. | |
| Over the past 10 months, we've build up instructor with the [principle](../../why.md) of 'easy to try, and easy to delete'. We accomplished this by patching the openai client with the `instructor` package and adding new arguments like `response_model`, `max_retries`, and `context`. As a result I truly believe instructor is the [best way](./best_framework.md) to get structured data out of llm apis. |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
instructor | 18136bf | Oct 01 2025, 01:48 PM |
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.
docs: replace deprecated validation_context with context parameter
Summary
Standardized all documentation to use the
context=parameter instead of the deprecatedvalidation_context=parameter across 9 documentation files. This includes updating code examples, comments, and prose references throughout the docs to reflect thatvalidation_contexthas been deprecated in favor of the simplercontextparameter name.Files Updated:
Review & Testing Checklist for Human
context=parametercontext=is indeed the current/preferred parameter name in the actual instructor codebasevalidation_contextreferences that might have been missedNotes
context=parameter usageImportant
Replaces deprecated
validation_contextwithcontextin documentation across 9 files, updating examples and references.validation_contextwithcontextin 9 documentation files.hooks.md,patching.mdexact_citations.md,bulk_classification.md,youtube_clips.mdvalidation-part1.md,version-1.mdllms.txtuniversal_self_consistency.mdThis description was created by
for 18136bf. You can customize this summary. It will automatically update as commits are pushed.