docs: update VERCEL_AI_SDK.md for AI SDK v5 compatibility #9119
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
Document breaking changes introduced in AI SDK v5 upgrade: - maxTokens → maxOutputTokens parameter rename - toolCall.args → toolCall.input property rename - usage.promptTokens → usage.inputTokens property rename - usage.completionTokens → usage.outputTokens property rename Add dedicated AI SDK v5 Migration section with: - Complete list of breaking changes - Files modified in openai-adapters package - Version requirements and compatibility notes - Zero consumer impact confirmation Generated with [Continue](https://continue.dev) Co-authored-by: nate <[email protected]> Co-Authored-By: Continue <[email protected]>
dosubot
bot
added
the
size:M
Contributor
Author
|
✅ Documentation review complete. This PR only contains documentation updates and doesn't introduce any code changes that would require additional documentation. No further documentation PR needed. |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
RomneyDa
merged commit 465ddfb
into
snyk-fix-29893fa185d8c83d0ae23b9800ed9849
8 checks passed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Updates documentation in
VERCEL_AI_SDK.mdto reflect breaking API changes introduced in AI SDK v5 (upgraded from v4.3.19 to v5.0.52 in PR #9113, code fixes in PR #9118).Changes
Added comprehensive documentation for AI SDK v5 breaking changes:
Breaking Changes Documented
maxTokens→maxOutputTokenstoolCall.args→toolCall.inputresult.usage.promptTokens→result.usage.inputTokensresult.usage.completionTokens→result.usage.outputTokensNew Documentation Section
Added "AI SDK v5 Migration" section containing:
Enhanced Examples
Updated code examples throughout to show v5 API usage:
maxOutputTokensRelated PRs
Files Modified
packages/openai-adapters/VERCEL_AI_SDK.mdTesting
Documentation-only changes. No code modifications.
This agent session was co-authored by nate and Continue.
Summary by cubic
Updates VERCEL_AI_SDK.md to align with AI SDK v5 and document breaking changes, with updated examples and a clear migration path. Ensures the docs match the v5 code and confirms no consumer code changes.
Written for commit 6529296. Summary will update automatically on new commits.