Repository navigation
docs(ai-groq,ai-grok,ai-mistral): fix README examples importing nonexistent generate/generateImages - #1957
Conversation
…istent generate/generateImages Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: bb24240 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
Chat examples and release entries .changeset/readme-fix-generate-imports.md, packages/ai-grok/README.md, packages/ai-groq/README.md, packages/ai-mistral/README.md |
The chat examples use chat, add a thread ID, and set stream: false. The changeset declares patch releases for the three packages. |
Grok image-generation example packages/ai-grok/README.md |
The example uses generateImage, passes the model to grokImage, and adds a thread ID. |
Estimated code review effort: 2 (Simple) | ~8 minutes
Change: Bug fix
Suggested reviewers: alemtuzlak
Merge Risk: 
Minimal · up to bb242
-
The README examples and release metadata match the supported APIs, with no merge-blocking risk identified.
Pre-merge checks: 
5
-
Full details: Description check
-
Explanation
The description includes all required sections, explains the changes and release impact, documents the changeset, and addresses why docs were not changed. Some checklist items remain unchecked, but the description is otherwise complete.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)
-
Finishing Touches
-
Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
|
Thanks for the PR, @pcbeingused333! 🙌 @tombeckenham will take a look. Automated pre-review checks
Automated triage — a human review follows. |
🎯 Changes
The usage examples in the
@tanstack/ai-groq,@tanstack/ai-grokand@tanstack/ai-mistralREADMEs importgeneratefrom@tanstack/ai(andgenerateImagesin the Grok image example).@tanstack/aiexports neither, so the examples fail as written.chat({ adapter, threadId, stream: false, messages }), the non-streaming form documented forchat();result.textis unchanged.generateImage, passes the model togrokImage('grok-imagine-image-2.0')(its signature takes the model) and addsthreadId.model:option from the Groq and Mistral examples; the model comes from the adapter.No runtime code is touched. The snippets were checked against the names exported from
packages/ai/src/index.tsand the adapter signatures; they were not run against the provider APIs.docs/is not changed because the broken examples only exist in these package READMEs.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.docs/for this change, or this change is not user-facing.pnpm changeset), or this PR does not change a published package.🚀 Release Impact
Disclosure: this change was prepared with the assistance of Claude, an AI coding agent.
🤖 Generated with Claude Code
Summary by CodeRabbit
chatwith non-streaming responses and thread IDs.generateImage, with the model configured through the adapter.generateandgenerateImagesusage from the affected examples.