docs: clarify v2 JSON extraction format and add real-world event example #111
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=80&v=4){kind=small}
- Add prominent note about v2 API format changes at top of page
- Add new 'Real-world example' section demonstrating complex nested schema extraction
- Update JSON format options section to emphasize v2 differences from v1
- Create comprehensive event extraction examples (cURL, Python, Node.js) using Gemeinde Grünwald calendar
- Clarify that jsonOptions parameter doesn't exist in v2 API
- Schema must be embedded directly in format object: formats: [{type: 'json', schema: {...}}]
Co-Authored-By: [email protected] <[email protected]>
🤖 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:
|
- Replace Gemeinde Grünwald event examples with firecrawl.dev company info - Update schema to use company_mission, supports_sso, is_open_source, is_in_yc - Simplify examples across cURL, Python, and Node.js - Update output to match new schema format Co-Authored-By: [email protected] <[email protected]>
- Rename JsonSchema to CompanyInfo to avoid confusion with v1 naming - Use .model_json_schema() for proper Pydantic model conversion - Standardize all examples to use https://firecrawl.dev Co-Authored-By: [email protected] <[email protected]>
Chadha93
approved these changes
Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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: clarify v2 JSON extraction format and add real-world example
Summary
Updates the v2 JSON extraction documentation to address user confusion about format changes from v1 to v2. Users were experiencing API errors because they expected the v1
jsonOptionsparameter to work in v2, but v2 requires the schema to be embedded directly inside the format object.Key changes:
jsonOptionsdoesn't existReview & Testing Checklist for Human
This is a yellow risk PR - documentation changes that need verification against live API behavior.
jsonOptionstruly doesn't exist in v2 and that the schema-in-format-object structure is correctNotes
events-example/directory but contain company info examples (low priority)