diff --git a/.changeset/readme-fix-generate-imports.md b/.changeset/readme-fix-generate-imports.md new file mode 100644 index 0000000000..eedee3d928 --- /dev/null +++ b/.changeset/readme-fix-generate-imports.md @@ -0,0 +1,7 @@ +--- +'@tanstack/ai-groq': patch +'@tanstack/ai-grok': patch +'@tanstack/ai-mistral': patch +--- + +Fix the README usage examples: they imported `generate` (and `generateImages` for Grok) from `@tanstack/ai`, which do not exist. They now use `chat({ stream: false })` and `generateImage`. diff --git a/packages/ai-grok/README.md b/packages/ai-grok/README.md index ccae404e6e..7b16214385 100644 --- a/packages/ai-grok/README.md +++ b/packages/ai-grok/README.md @@ -46,12 +46,14 @@ export XAI_API_KEY="xai-..." ```typescript import { grokText } from '@tanstack/ai-grok' -import { generate } from '@tanstack/ai' +import { chat } from '@tanstack/ai' const adapter = grokText('grok-build-0.1') -const result = await generate({ +const result = await chat({ adapter, + threadId: 'thread-1', + stream: false, messages: [ { role: 'user', content: 'Explain quantum computing in simple terms' }, ], @@ -82,13 +84,13 @@ console.log(result.summary) ```typescript import { grokImage } from '@tanstack/ai-grok' -import { generateImages } from '@tanstack/ai' +import { generateImage } from '@tanstack/ai' -const adapter = grokImage() +const adapter = grokImage('grok-imagine-image-2.0') -const result = await generateImages({ +const result = await generateImage({ adapter, - model: 'grok-imagine-image-2.0', + threadId: 'thread-1', prompt: 'A beautiful sunset over mountains', numberOfImages: 1, size: '16:9', diff --git a/packages/ai-groq/README.md b/packages/ai-groq/README.md index 264806a630..067dfe2960 100644 --- a/packages/ai-groq/README.md +++ b/packages/ai-groq/README.md @@ -46,13 +46,14 @@ export GROQ_API_KEY="gsk_..." ```typescript import { groqText } from '@tanstack/ai-groq' -import { generate } from '@tanstack/ai' +import { chat } from '@tanstack/ai' const adapter = groqText('openai/gpt-oss-120b') -const result = await generate({ +const result = await chat({ adapter, - model: 'openai/gpt-oss-120b', + threadId: 'thread-1', + stream: false, messages: [ { role: 'user', content: 'Explain quantum computing in simple terms' }, ], diff --git a/packages/ai-mistral/README.md b/packages/ai-mistral/README.md index d4dbf08034..e915375e80 100644 --- a/packages/ai-mistral/README.md +++ b/packages/ai-mistral/README.md @@ -46,13 +46,14 @@ export MISTRAL_API_KEY="..." ```typescript import { mistralText } from '@tanstack/ai-mistral' -import { generate } from '@tanstack/ai' +import { chat } from '@tanstack/ai' const adapter = mistralText('mistral-large-latest') -const result = await generate({ +const result = await chat({ adapter, - model: 'mistral-large-latest', + threadId: 'thread-1', + stream: false, messages: [ { role: 'user', content: 'Explain quantum computing in simple terms' }, ],