Skip to content
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

Document use of SkipJsonSchema for omitting fields #597

Merged

Conversation

boydgreenfield
Copy link
Contributor

@boydgreenfield boydgreenfield commented Apr 12, 2024

Ellipsis 🚀 This PR description was created by Ellipsis for commit 503ad32.

Summary:

This PR adds documentation for the use of SkipJsonSchema to omit fields from the JSON schema in Pydantic models.

Key points:

  • Added documentation for SkipJsonSchema usage in /docs/concepts/fields.md.
  • Updated /docs/concepts/models.md to reference the new section in fields.md.

Generated with ❤️ by ellipsis.dev

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 12, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me!

  • Reviewed the entire pull request up to 503ad32
  • Looked at 53 lines of code in 2 files
  • Took 1 minute and 6 seconds to review
More info
  • Skipped 0 files when reviewing.
  • Skipped posting 2 additional comments because they didn't meet confidence threshold of 85%.
1. docs/concepts/fields.md:91:
  • Assessed confidence : 0%
  • Comment:
    The explanation and example of using SkipJsonSchema to omit fields from the schema sent to the language model are clear and correct.
  • Reasoning:
    The PR is about documenting the use of SkipJsonSchema for omitting fields. The changes made in the files fields.md and models.md are correct and provide clear examples and explanations. There are no violations of best practices, logical bugs, performance bugs, or security bugs. The changes are also consistent with the rest of the documentation.
2. docs/concepts/models.md:46:
  • Assessed confidence : 0%
  • Comment:
    The note about using SkipJsonSchema to omit fields from being sent to the language model is accurate and provides a helpful link for more details.
  • Reasoning:
    The changes made in the models.md file are also correct. The note added about the possibility of omitting fields entirely from being sent to the language model using SkipJsonSchema is accurate and provides a link to the relevant section for more details.

Workflow ID: wflow_FDQVBzssXVbmn3io


Not what you expected? You can customize the content of the reviews using rules. Learn more here.

@jxnl jxnl merged commit d3fe50c into instructor-ai:main Apr 12, 2024
@boydgreenfield boydgreenfield deleted the boyd/pydantic-skipjsonschema-docs branch April 12, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants