chore: deprecate text based way of generating JSON #920
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.
Relates to:
N/A prevent future folks from using the untyped version generateObject so folks use generateObjectV2 which is typesafe. Just a rename for now to reduce risk of regression. We will clean up old usages separately.
Risks
Low
Background
What does this PR do?
This PR deprecates the text-based way of generating JSON objects using LLMs and so folks use generatedObjectV2 with typesafe structured outputs. Method isn't removed yet it is deprecated.
What kind of change is this?
Why are we doing this? Any context or related work?
Text-based generation of JSON using LLMs is prone to errors like missing brackets, invalid types, or inconsistent structures. Moving to a typesafe structured output guarantees that JSON complies with predefined schemas, improving both developer experience and system stability.
Documentation changes needed?
Testing
Where should a reviewer start?
Detailed testing steps
N/A just a rename
Deploy Notes
No special deployment steps required.
Database changes
None.
Deployment instructions
Standard deployment process applies.
Discord username
0x8664