ai 6.0.31 → 6.0.33

package/docs/08-migration-guides/36-migration-guide-3-4.mdx

@@ -0,0 +1,14 @@
+---
+title: Migrate AI SDK 3.3 to 3.4
+description: Learn how to upgrade AI SDK 3.3 to 3.4.
+---
+
+# Migrate AI SDK 3.3 to 3.4
+
+<Note>
+  Check out the [AI SDK 3.4 release blog
+  post](https://vercel.com/blog/ai-sdk-3-4) for more information about the
+  release.
+</Note>
+
+No breaking changes in this release.

package/docs/08-migration-guides/37-migration-guide-3-3.mdx

@@ -0,0 +1,64 @@
+---
+title: Migrate AI SDK 3.2 to 3.3
+description: Learn how to upgrade AI SDK 3.2 to 3.3.
+---
+
+# Migrate AI SDK 3.2 to 3.3
+
+<Note>
+  Check out the [AI SDK 3.3 release blog
+  post](https://vercel.com/blog/vercel-ai-sdk-3-3) for more information about
+  the release.
+</Note>
+
+No breaking changes in this release.
+
+The following changelog encompasses all changes made in the 3.2.x series,
+introducing significant improvements and new features across the AI SDK and its associated libraries:
+
+## New Features
+
+### Open Telemetry Support
+
+- Added experimental [OpenTelemetry support](/docs/ai-sdk-core/telemetry#telemetry) for all [AI SDK Core functions](/docs/ai-sdk-core/overview#ai-sdk-core-functions), enabling better observability and tracing capabilities.
+
+### AI SDK UI Improvements
+
+- Introduced the experimental **`useObject`** hook (for React) that can be used in conjunction with **`streamObject`** on the backend to enable seamless streaming of structured data.
+- Enhanced **`useChat`** with experimental support for attachments and streaming tool calls, providing more versatile chat functionalities.
+- Patched **`useChat`** to prevent empty submissions, improving the quality of user interactions by ensuring that only intended inputs are processed.
+- Fix **`useChat`**'s **`reload`** function, now correctly sending data, body, and headers.
+- Implemented **`setThreadId`** helper for **`useAssistant`**, simplifying thread management.
+- Documented the stream data protocol for **`useChat`** and **`useCompletion`**, allowing developers to use these functions with any backend. The stream data protocol also enables the use of custom frontends with **`streamText`**.
+- Added support for custom fetch functions and request body customization, offering greater control over API interactions.
+- Added **`onFinish`** to **`useChat`** hook for access to token usage and finish reason.
+
+### Core Enhancements
+
+- Implemented support for sending custom request headers, enabling more tailored API requests.
+- Added raw JSON schema support alongside existing Zod support, providing more options for schema and data validation.
+- Introduced usage information for **`embed`** and **`embedMany`** functions, offering insights into token usage.
+- Added support for additional settings including **`stopSequences`** and **`topK`**, allowing for finer control over text generation.
+- Provided access to information for all steps on **`generateText`**, providing access to intermediate tool calls and results.
+
+### New Providers
+
+- [AWS Bedrock provider](/providers/ai-sdk-providers/amazon-bedrock).
+
+### Provider Improvements
+
+- Enhanced existing providers including Anthropic, Google, Azure, and OpenAI with various improvements and bug fixes.
+- Upgraded the LangChain adapter with StreamEvent v2 support and introduced the **`toDataStreamResponse`** function, enabling conversion of LangChain output streams to data stream responses.
+- Added legacy function calling support to the OpenAI provider.
+- Updated Mistral AI provider with fixes and improvements for tool calling support.
+
+### UI Framework Support Expansion
+
+- SolidJS: Updated **`useChat`** and **`useCompletion`** to achieve feature parity with React implementations.
+- Vue.js: Introduced **`useAssistant`** hook.
+- Vue.js / Nuxt: [Updated examples](https://github.com/vercel/ai/tree/main/examples/nuxt-openai) to showcase latest features and best practices.
+- Svelte: Added tool calling support to **`useChat`.**
+
+## Fixes and Improvements
+
+- Resolved various issues across different components of the SDK, including race conditions, error handling, and state management.

package/docs/08-migration-guides/38-migration-guide-3-2.mdx

@@ -0,0 +1,46 @@
+---
+title: Migrate AI SDK 3.1 to 3.2
+description: Learn how to upgrade AI SDK 3.1 to 3.2.
+---
+
+# Migrate AI SDK 3.1 to 3.2
+
+<Note>
+  Check out the [AI SDK 3.2 release blog
+  post](https://vercel.com/blog/introducing-vercel-ai-sdk-3-2) for more
+  information about the release.
+</Note>
+
+This guide will help you upgrade to AI SDK 3.2:
+
+- Experimental `StreamingReactResponse` functionality has been removed
+- Several features have been deprecated
+- UI framework integrations have moved to their own Node modules
+
+## Upgrading
+
+### AI SDK
+
+To update to AI SDK version 3.2, run the following command using your preferred package manager:
+
+<Snippet text="pnpm add ai@latest" />
+
+## Removed Functionality
+
+The experimental `StreamingReactResponse` has been removed. You can use [AI SDK RSC](/docs/ai-sdk-rsc/overview) to build streaming UIs.
+
+## Deprecated Functionality
+
+The `nanoid` export has been deprecated. Please use [`generateId`](/docs/reference/ai-sdk-core/generate-id) instead.
+
+## UI Package Separation
+
+AI SDK UI supports several frameworks: [React](https://react.dev/), [Svelte](https://svelte.dev/), [Vue.js](https://vuejs.org/), and [SolidJS](https://www.solidjs.com/).
+
+The integrations (other than React and RSC) have moved to separate Node modules. You need to update the import and require statements as follows:
+
+- Change `ai/svelte` to `@ai-sdk/svelte`
+- Change `ai/vue` to `@ai-sdk/vue`
+- Change `ai/solid` to `@ai-sdk/solid`
+
+The old exports are still available but will be removed in a future release.

package/docs/08-migration-guides/39-migration-guide-3-1.mdx

@@ -0,0 +1,168 @@
+---
+title: Migrate AI SDK 3.0 to 3.1
+description: Learn how to upgrade AI SDK 3.0 to 3.1.
+---
+
+# Migrate AI SDK 3.0 to 3.1
+
+<Note>
+  Check out the [AI SDK 3.1 release blog
+  post](https://vercel.com/blog/vercel-ai-sdk-3-1-modelfusion-joins-the-team)
+  for more information about the release.
+</Note>
+
+This guide will help you:
+
+- Upgrade to AI SDK 3.1
+- Migrate from Legacy Providers to AI SDK Core
+- Migrate from [`render`](/docs/reference/ai-sdk-rsc/render) to [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui)
+
+Upgrading to AI SDK 3.1 does not require using the newly released AI SDK Core API or [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui) function.
+
+## Upgrading
+
+### AI SDK
+
+To update to AI SDK version 3.1, run the following command using your preferred package manager:
+
+<Snippet text="pnpm add ai@3.1" />
+
+## Next Steps
+
+The release of AI SDK 3.1 introduces several new features that improve the way you build AI applications with the SDK:
+
+- AI SDK Core, a brand new unified API for interacting with large language models (LLMs).
+- [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui), a new abstraction, built upon AI SDK Core functions that simplifies building streaming UIs.
+
+## Migrating from Legacy Providers to AI SDK Core
+
+Prior to AI SDK Core, you had to use a model provider's SDK to query their models.
+
+In the following Route Handler, you use the OpenAI SDK to query their model. You then pipe that response into the [`OpenAIStream`](/docs/reference/stream-helpers/openai-stream) function which returns a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) that you can pass to the client using a new [`StreamingTextResponse`](/docs/reference/stream-helpers/streaming-text-response).
+
+```tsx
+import OpenAI from 'openai';
+import { OpenAIStream, StreamingTextResponse } from 'ai';
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY!,
+});
+
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+
+  const response = await openai.chat.completions.create({
+    model: 'gpt-4.1',
+    stream: true,
+    messages,
+  });
+
+  const stream = OpenAIStream(response);
+
+  return new StreamingTextResponse(stream);
+}
+```
+
+With AI SDK Core you have a unified API for any provider that implements the [AI SDK Language Model Specification](/providers/community-providers/custom-providers).
+
+Let’s take a look at the example above, but refactored to utilize the AI SDK Core API alongside the AI SDK OpenAI provider. In this example, you import the LLM function you want to use from the `ai` package, import the OpenAI provider from `@ai-sdk/openai`, and then you call the model and return the response using the `toDataStreamResponse()` helper function.
+
+```tsx
+import { streamText } from 'ai';
+import { openai } from '@ai-sdk/openai';
+__PROVIDER_IMPORT__;
+
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+
+  const result = await streamText({
+    model: __MODEL__,
+    messages,
+  });
+
+  return result.toUIMessageStreamResponse();
+}
+```
+
+## Migrating from `render` to `streamUI`
+
+The AI SDK RSC API was launched as part of version 3.0. This API introduced the [`render`](/docs/reference/ai-sdk-rsc/render) function, a helper function to create streamable UIs with OpenAI models. With the new AI SDK Core API, it became possible to make streamable UIs possible with any compatible provider.
+
+The following example Server Action uses the `render` function using the model provider directly from OpenAI. You first create an OpenAI provider instance with the OpenAI SDK. Then, you pass it to the provider key of the render function alongside a tool that returns a React Server Component, defined in the `render` key of the tool.
+
+```tsx
+import { render } from '@ai-sdk/rsc';
+import OpenAI from 'openai';
+import { z } from 'zod';
+import { Spinner, Weather } from '@/components';
+import { getWeather } from '@/utils';
+
+const openai = new OpenAI();
+
+async function submitMessage(userInput = 'What is the weather in SF?') {
+  'use server';
+
+  return render({
+    provider: openai,
+    model: 'gpt-4.1',
+    messages: [
+      { role: 'system', content: 'You are a helpful assistant' },
+      { role: 'user', content: userInput },
+    ],
+    text: ({ content }) => <p>{content}</p>,
+    tools: {
+      get_city_weather: {
+        description: 'Get the current weather for a city',
+        parameters: z
+          .object({
+            city: z.string().describe('the city'),
+          })
+          .required(),
+        render: async function* ({ city }) {
+          yield <Spinner />;
+          const weather = await getWeather(city);
+          return <Weather info={weather} />;
+        },
+      },
+    },
+  });
+}
+```
+
+With the new [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui) function, you can now use any compatible AI SDK provider. In this example, you import the AI SDK OpenAI provider. Then, you pass it to the [`model`](/docs/reference/ai-sdk-rsc/stream-ui#model) key of the new [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui) function. Finally, you declare a tool and return a React Server Component, defined in the [`generate`](/docs/reference/ai-sdk-rsc/stream-ui#tools-generate) key of the tool.
+
+```tsx
+import { streamUI } from '@ai-sdk/rsc';
+import { openai } from '@ai-sdk/openai';
+import { z } from 'zod';
+import { Spinner, Weather } from '@/components';
+import { getWeather } from '@/utils';
+
+async function submitMessage(userInput = 'What is the weather in SF?') {
+  'use server';
+
+  const result = await streamUI({
+    model: __MODEL__,
+    system: 'You are a helpful assistant',
+    messages: [{ role: 'user', content: userInput }],
+    text: ({ content }) => <p>{content}</p>,
+    tools: {
+      get_city_weather: {
+        description: 'Get the current weather for a city',
+        parameters: z
+          .object({
+            city: z.string().describe('Name of the city'),
+          })
+          .required(),
+        generate: async function* ({ city }) {
+          yield <Spinner />;
+          const weather = await getWeather(city);
+          return <Weather info={weather} />;
+        },
+      },
+    },
+  });
+
+  return result.value;
+}
+```

package/docs/08-migration-guides/index.mdx

@@ -0,0 +1,22 @@
+---
+title: Migration Guides
+description: Learn how to upgrade between Vercel AI versions.
+collapsed: true
+---
+
+# Migration Guides
+
+- [ Migrate AI SDK 5.x to 6.0 ](/docs/migration-guides/migration-guide-6-0)
+- [ Migrate AI SDK 4.x to 5.0 ](/docs/migration-guides/migration-guide-5-0)
+- [ Migrate your data to AI SDK 5.0 ](/docs/migration-guides/migration-guide-5-0-data)
+- [ Migrate AI SDK 4.1 to 4.2 ](/docs/migration-guides/migration-guide-4-2)
+- [ Migrate AI SDK 4.0 to 4.1 ](/docs/migration-guides/migration-guide-4-1)
+- [ Migrate AI SDK 3.4 to 4.0 ](/docs/migration-guides/migration-guide-4-0)
+- [ Migrate AI SDK 3.3 to 3.4 ](/docs/migration-guides/migration-guide-3-4)
+- [ Migrate AI SDK 3.2 to 3.3 ](/docs/migration-guides/migration-guide-3-3)
+- [ Migrate AI SDK 3.1 to 3.2 ](/docs/migration-guides/migration-guide-3-2)
+- [ Migrate AI SDK 3.0 to 3.1 ](/docs/migration-guides/migration-guide-3-1)
+
+## Versioning
+
+- [ Versioning ](/docs/migration-guides/versioning)

package/docs/09-troubleshooting/01-azure-stream-slow.mdx

@@ -0,0 +1,33 @@
+---
+title: Azure OpenAI Slow to Stream
+description: Learn to troubleshoot Azure OpenAI slow to stream issues.
+---
+
+# Azure OpenAI Slow To Stream
+
+## Issue
+
+When using OpenAI hosted on Azure, streaming is slow and in big chunks.
+
+## Cause
+
+This is a Microsoft Azure issue. Some users have reported the following solutions:
+
+- **Update Content Filtering Settings**:
+  Inside [Azure AI Studio](https://ai.azure.com/), within "Shared resources" > "Content filters", create a new
+  content filter and set the "Streaming mode (Preview)" under "Output filter" from "Default"
+  to "Asynchronous Filter".
+
+## Solution
+
+You can use the [`smoothStream` transformation](/docs/ai-sdk-core/generating-text#smoothing-streams) to stream each word individually.
+
+```tsx highlight="6"
+import { smoothStream, streamText } from 'ai';
+
+const result = streamText({
+  model,
+  prompt,
+  experimental_transform: smoothStream(),
+});
+```

package/docs/09-troubleshooting/02-client-side-function-calls-not-invoked.mdx

@@ -0,0 +1,22 @@
+---
+title: Client-Side Function Calls Not Invoked
+description: Troubleshooting client-side function calls not being invoked.
+---
+
+# Client-Side Function Calls Not Invoked
+
+## Issue
+
+I upgraded the AI SDK to v3.0.20 or newer. I am using [`OpenAIStream`](/docs/reference/stream-helpers/openai-stream). Client-side function calls are no longer invoked.
+
+## Solution
+
+You will need to add a stub for `experimental_onFunctionCall` to [`OpenAIStream`](/docs/reference/stream-helpers/openai-stream) to enable the correct forwarding of the function calls to the client.
+
+```tsx
+const stream = OpenAIStream(response, {
+  async experimental_onFunctionCall() {
+    return;
+  },
+});
+```

package/docs/09-troubleshooting/03-server-actions-in-client-components.mdx

@@ -0,0 +1,40 @@
+---
+title: Server Actions in Client Components
+description: Troubleshooting errors related to server actions in client components.
+---
+
+# Server Actions in Client Components
+
+You may use Server Actions in client components, but sometimes you may encounter the following issues.
+
+## Issue
+
+It is not allowed to define inline `"use server"` annotated Server Actions in Client Components.
+
+## Solution
+
+To use Server Actions in a Client Component, you can either:
+
+- Export them from a separate file with `"use server"` at the top.
+- Pass them down through props from a Server Component.
+- Implement a combination of [`createAI`](/docs/reference/ai-sdk-rsc/create-ai) and [`useActions`](/docs/reference/ai-sdk-rsc/use-actions) hooks to access them.
+
+Learn more about [Server Actions and Mutations](https://nextjs.org/docs/app/api-reference/functions/server-actions#with-client-components).
+
+```ts file='actions.ts'
+'use server';
+
+import { generateText } from 'ai';
+__PROVIDER_IMPORT__;
+
+export async function getAnswer(question: string) {
+  'use server';
+
+  const { text } = await generateText({
+    model: __MODEL__,
+    prompt: question,
+  });
+
+  return { answer: text };
+}
+```

package/docs/09-troubleshooting/04-strange-stream-output.mdx

@@ -0,0 +1,36 @@
+---
+title: useChat/useCompletion stream output contains 0:... instead of text
+description: How to fix strange stream output in the UI
+---
+
+# useChat/useCompletion stream output contains 0:... instead of text
+
+## Issue
+
+I am using custom client code to process a server response that is sent using [`StreamingTextResponse`](/docs/reference/stream-helpers/streaming-text-response). I am using version `3.0.20` or newer of the AI SDK. When I send a query, the UI streams text such as `0: "Je"`, `0: " suis"`, `0: "des"...` instead of the text that I’m looking for.
+
+## Background
+
+The AI SDK has switched to the stream data protocol in version `3.0.20`. It sends different stream parts to support data, tool calls, etc. What you see is the raw stream data protocol response.
+
+## Solution
+
+You have several options:
+
+1. Use the AI Core [`streamText`](/docs/reference/ai-sdk-core/stream-text) function to send a raw text stream:
+
+   ```tsx
+   export async function POST(req: Request) {
+     const { prompt } = await req.json();
+
+     const result = streamText({
+       model: openai.completion('gpt-3.5-turbo-instruct'),
+       maxOutputTokens: 2000,
+       prompt,
+     });
+
+     return result.toTextStreamResponse();
+   }
+   ```
+
+2. Pin the AI SDK version to `3.0.19` . This will keep the raw text stream.

package/docs/09-troubleshooting/05-streamable-ui-errors.mdx

@@ -0,0 +1,16 @@
+---
+title: Streamable UI Errors
+description: Troubleshooting errors related to streamable UI.
+---
+
+# Streamable UI Component Error
+
+## Issue
+
+- Variable Not Found
+- Cannot find `div`
+- `Component` refers to a value, but is being used as a type
+
+## Solution
+
+If you encounter these errors when working with streamable UIs within server actions, it is likely because the file ends in `.ts` instead of `.tsx`.

package/docs/09-troubleshooting/05-tool-invocation-missing-result.mdx

@@ -0,0 +1,106 @@
+---
+title: Tool Invocation Missing Result Error
+description: How to fix the "ToolInvocation must have a result" error when using tools without execute functions
+---
+
+# Tool Invocation Missing Result Error
+
+## Issue
+
+When using `generateText()` or `streamText()`, you may encounter the error "ToolInvocation must have a result" when a tool without an `execute` function is called.
+
+## Cause
+
+The error occurs when you define a tool without an `execute` function and don't provide the result through other means (like `useChat`'s `onToolCall` or `addToolOutput` functions).
+
+Each time a tool is invoked, the model expects to receive a result before continuing the conversation. Without a result, the model cannot determine if the tool call succeeded or failed and the conversation state becomes invalid.
+
+## Solution
+
+You have two options for handling tool results:
+
+1. Server-side execution using tools with an `execute` function:
+
+```tsx
+const tools = {
+  weather: tool({
+    description: 'Get the weather in a location',
+    parameters: z.object({
+      location: z
+        .string()
+        .describe('The city and state, e.g. "San Francisco, CA"'),
+    }),
+    execute: async ({ location }) => {
+      // Fetch and return weather data
+      return { temperature: 72, conditions: 'sunny', location };
+    },
+  }),
+};
+```
+
+2. Client-side execution with `useChat` (omitting the `execute` function), you must provide results using `addToolOutput`:
+
+```tsx
+import { useChat } from '@ai-sdk/react';
+import {
+  DefaultChatTransport,
+  lastAssistantMessageIsCompleteWithToolCalls,
+} from 'ai';
+
+const { messages, sendMessage, addToolOutput } = useChat({
+  // Automatically submit when all tool results are available
+  sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
+
+  // Handle tool calls in onToolCall
+  onToolCall: async ({ toolCall }) => {
+    if (toolCall.toolName === 'getLocation') {
+      try {
+        const result = await getLocationData();
+
+        // Important: Don't await inside onToolCall to avoid deadlocks
+        addToolOutput({
+          tool: 'getLocation',
+          toolCallId: toolCall.toolCallId,
+          output: result,
+        });
+      } catch (err) {
+        // Important: Don't await inside onToolCall to avoid deadlocks
+        addToolOutput({
+          tool: 'getLocation',
+          toolCallId: toolCall.toolCallId,
+          state: 'output-error',
+          errorText: 'Failed to get location',
+        });
+      }
+    }
+  },
+});
+```
+
+```tsx
+// For interactive UI elements:
+const { messages, sendMessage, addToolOutput } = useChat({
+  transport: new DefaultChatTransport({ api: '/api/chat' }),
+  sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
+});
+
+// Inside your JSX, when rendering tool calls:
+<button
+  onClick={() =>
+    addToolOutput({
+      tool: 'myTool',
+      toolCallId, // must provide tool call ID
+      output: {
+        /* your tool result */
+      },
+    })
+  }
+>
+  Confirm
+</button>;
+```
+
+<Note type="warning">
+  Whether handling tools on the server or client, each tool call must have a
+  corresponding result before the conversation can continue.
+</Note>

package/docs/09-troubleshooting/06-streaming-not-working-when-deployed.mdx

@@ -0,0 +1,31 @@
+---
+title: Streaming Not Working When Deployed
+description: Troubleshooting streaming issues in deployed apps.
+---
+
+# Streaming Not Working When Deployed
+
+## Issue
+
+Streaming with the AI SDK works in my local development environment.
+However, when deploying, streaming does not work in the deployed app.
+Instead of streaming, only the full response is returned after a while.
+
+## Cause
+
+The causes of this issue are varied and depend on the deployment environment.
+
+## Solution
+
+You can try the following:
+
+- add `'Transfer-Encoding': 'chunked'` and/or `Connection: 'keep-alive'` headers
+
+  ```tsx
+  return result.toUIMessageStreamResponse({
+    headers: {
+      'Transfer-Encoding': 'chunked',
+      Connection: 'keep-alive',
+    },
+  });
+  ```

package/docs/09-troubleshooting/06-streaming-not-working-when-proxied.mdx

@@ -0,0 +1,31 @@
+---
+title: Streaming Not Working When Proxied
+description: Troubleshooting streaming issues in proxied apps.
+---
+
+# Streaming Not Working When Proxied
+
+## Issue
+
+Streaming with the AI SDK doesn't work in local development environment, or deployed in some proxy environments.
+Instead of streaming, only the full response is returned after a while.
+
+## Cause
+
+The causes of this issue are caused by the proxy middleware.
+
+If the middleware is configured to compress the response, it will cause the streaming to fail.
+
+## Solution
+
+You can try the following, the solution only affects the streaming API:
+
+- add `'Content-Encoding': 'none'` headers
+
+  ```tsx
+  return result.toUIMessageStreamResponse({
+    headers: {
+      'Content-Encoding': 'none',
+    },
+  });
+  ```