ai 6.0.31 → 6.0.32

package/docs/02-foundations/04-tools.mdx

@@ -0,0 +1,160 @@
+---
+title: Tools
+description: Learn about tools with the AI SDK.
+---
+
+# Tools
+
+While [large language models (LLMs)](/docs/foundations/overview#large-language-models) have incredible generation capabilities,
+they struggle with discrete tasks (e.g. mathematics) and interacting with the outside world (e.g. getting the weather).
+
+Tools are actions that an LLM can invoke.
+The results of these actions can be reported back to the LLM to be considered in the next response.
+
+For example, when you ask an LLM for the "weather in London", and there is a weather tool available, it could call a tool
+with London as the argument. The tool would then fetch the weather data and return it to the LLM. The LLM can then use this
+information in its response.
+
+## What is a tool?
+
+A tool is an object that can be called by the model to perform a specific task.
+You can use tools with [`generateText`](/docs/reference/ai-sdk-core/generate-text)
+and [`streamText`](/docs/reference/ai-sdk-core/stream-text) by passing one or more tools to the `tools` parameter.
+
+A tool consists of three properties:
+
+- **`description`**: An optional description of the tool that can influence when the tool is picked.
+- **`inputSchema`**: A [Zod schema](/docs/foundations/tools#schema-specification-and-validation-with-zod) or a [JSON schema](/docs/reference/ai-sdk-core/json-schema) that defines the input required for the tool to run. The schema is consumed by the LLM, and also used to validate the LLM tool calls.
+- **`execute`**: An optional async function that is called with the arguments from the tool call.
+
+<Note>
+  `streamUI` uses UI generator tools with a `generate` function that can return
+  React components.
+</Note>
+
+If the LLM decides to use a tool, it will generate a tool call.
+Tools with an `execute` function are run automatically when these calls are generated.
+The output of the tool calls are returned using tool result objects.
+
+You can automatically pass tool results back to the LLM
+using [multi-step calls](/docs/ai-sdk-core/tools-and-tool-calling#multi-step-calls) with `streamText` and `generateText`.
+
+## Schemas
+
+Schemas are used to define and validate the [tool input](/docs/ai-sdk-core/tools-and-tool-calling), tools outputs, and structured output generation.
+
+The AI SDK supports the following schemas:
+
+- [Zod](https://zod.dev/) v3 and v4 directly or via [`zodSchema()`](/docs/reference/ai-sdk-core/zod-schema)
+- [Valibot](https://valibot.dev/) via [`valibotSchema()`](/docs/reference/ai-sdk-core/valibot-schema) from `@ai-sdk/valibot`
+- [Standard JSON Schema](https://standardschema.dev/json-schema) compatible schemas
+- Raw JSON schemas via [`jsonSchema()`](/docs/reference/ai-sdk-core/json-schema)
+
+<Note>
+  You can also use schemas for structured output generation with
+  [`generateText`](/docs/reference/ai-sdk-core/generate-text) and
+  [`streamText`](/docs/reference/ai-sdk-core/stream-text) using the `output`
+  setting.
+</Note>
+
+## Tool Packages
+
+Given tools are JavaScript objects, they can be packaged and distributed through npm like any other library. This makes it easy to share reusable tools across projects and with the community.
+
+### Using Ready-Made Tool Packages
+
+Install a tool package and import the tools you need:
+
+```bash
+pnpm add some-tool-package
+```
+
+Then pass them directly to `generateText`, `streamText`, or your agent definition:
+
+```ts highlight="2, 8"
+import { generateText, stepCountIs } from 'ai';
+import { searchTool } from 'some-tool-package';
+
+const { text } = await generateText({
+  model: 'anthropic/claude-haiku-4.5',
+  prompt: 'When was Vercel Ship AI?',
+  tools: {
+    webSearch: searchTool,
+  },
+  stopWhen: stepCountIs(10),
+});
+```
+
+### Publishing Your Own Tools
+
+You can publish your own tool packages to npm for others to use. Simply export your tool objects from your package:
+
+```ts
+// my-tools/index.ts
+export const myTool = {
+  description: 'A helpful tool',
+  inputSchema: z.object({
+    query: z.string(),
+  }),
+  execute: async ({ query }) => {
+    // your tool logic
+    return result;
+  },
+};
+```
+
+Anyone can then install and use your tools by importing them.
+
+To get started, you can use the [AI SDK Tool Package Template](https://github.com/vercel-labs/ai-sdk-tool-as-package-template) which provides a ready-to-use starting point for publishing your own tools.
+
+## Toolsets
+
+When you work with tools, you typically need a mix of application-specific tools and general-purpose tools. The community has created various toolsets and resources to help you build and use tools.
+
+### Ready-to-Use Tool Packages
+
+These packages provide pre-built tools you can install and use immediately:
+
+- **[@exalabs/ai-sdk](https://www.npmjs.com/package/@exalabs/ai-sdk)** - Web search tool that lets AI search the web and get real-time information.
+- **[@parallel-web/ai-sdk-tools](https://www.npmjs.com/package/@parallel-web/ai-sdk-tools)** - Web search and extract tools powered by Parallel Web API for real-time information and content extraction.
+- **[@perplexity-ai/ai-sdk](https://www.npmjs.com/package/@perplexity-ai/ai-sdk)** - Search the web with real-time results and advanced filtering powered by Perplexity's Search API.
+- **[@tavily/ai-sdk](https://www.npmjs.com/package/@tavily/ai-sdk)** - Search, extract, crawl, and map tools for enterprise-grade agents to explore the web in real-time.
+- **[Stripe agent tools](https://docs.stripe.com/agents?framework=vercel)** - Tools for interacting with Stripe.
+- **[StackOne ToolSet](https://docs.stackone.com/agents/typescript/frameworks/vercel-ai-sdk)** - Agentic integrations for hundreds of [enterprise SaaS](https://www.stackone.com/integrations) platforms.
+- **[agentic](https://docs.agentic.so/marketplace/ts-sdks/ai-sdk)** - A collection of 20+ tools that connect to external APIs such as [Exa](https://exa.ai/) or [E2B](https://e2b.dev/).
+- **[Amazon Bedrock AgentCore](https://github.com/aws/bedrock-agentcore-sdk-typescript)** - Fully managed AI agent services including [**Browser**](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/built-in-tools.html) (a fast and secure cloud-based browser runtime to enable agents to interact with web applications, fill forms, navigate websites, and extract information) and [**Code Interpreter**](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/built-in-tools.html) (an isolated sandbox environment for agents to execute code in Python, JavaScript, and TypeScript, enhancing accuracy and expanding ability to solve complex end-to-end tasks).
+- **[@airweave/vercel-ai-sdk](https://www.npmjs.com/package/@airweave/vercel-ai-sdk)** - Unified semantic search across 35+ data sources (Notion, Slack, Google Drive, databases, and more) for AI agents.
+- **[Composio](https://docs.composio.dev/providers/vercel)** - 250+ tools like GitHub, Gmail, Salesforce and [more](https://composio.dev/tools).
+- **[JigsawStack](http://www.jigsawstack.com/docs/integration/vercel)** - Over 30+ small custom fine-tuned models available for specific uses.
+- **[AI Tools Registry](https://ai-tools-registry.vercel.app)** - A Shadcn-compatible tool definitions and components registry for the AI SDK.
+- **[Toolhouse](https://docs.toolhouse.ai/toolhouse/toolhouse-sdk/using-vercel-ai)** - AI function-calling in 3 lines of code for over 25 different actions.
+- **[bash-tool](https://www.npmjs.com/package/bash-tool)** - Provides `bash`, `readFile`, and `writeFile` tools for AI agents. Supports [@vercel/sandbox](https://vercel.com/docs/vercel-sandbox) for full VM isolation.
+
+### MCP Tools
+
+These are pre-built tools available as MCP servers:
+
+- **[Smithery](https://smithery.ai/docs/integrations/vercel_ai_sdk)** - An open marketplace of 6,000+ MCPs, including [Browserbase](https://browserbase.com/) and [Exa](https://exa.ai/).
+- **[Pipedream](https://pipedream.com/docs/connect/mcp/ai-frameworks/vercel-ai-sdk)** - Developer toolkit that lets you easily add 3,000+ integrations to your app or AI agent.
+- **[Apify](https://docs.apify.com/platform/integrations/vercel-ai-sdk)** - Apify provides a [marketplace](https://apify.com/store) of thousands of tools for web scraping, data extraction, and browser automation.
+
+### Tool Building Tutorials
+
+These tutorials and guides help you build your own tools that integrate with specific services:
+
+- **[browserbase](https://docs.browserbase.com/integrations/vercel/introduction#vercel-ai-integration)** - Tutorial for building browser tools that run a headless browser.
+- **[browserless](https://docs.browserless.io/ai-integrations/vercel-ai-sdk)** - Guide for integrating browser automation (self-hosted or cloud-based).
+- **[AI Tool Maker](https://github.com/nihaocami/ai-tool-maker)** - A CLI utility to generate AI SDK tools from OpenAPI specs.
+- **[Interlify](https://www.interlify.com/docs/integrate-with-vercel-ai)** - Guide for converting APIs into tools.
+- **[DeepAgent](https://deepagent.amardeep.space/docs/vercel-ai-sdk)** - A suite of 50+ AI tools and integrations, seamlessly connecting with APIs like Tavily, E2B, Airtable and [more](https://deepagent.amardeep.space/docs).
+
+<Note>
+  Do you have open source tools or tool libraries that are compatible with the
+  AI SDK? Please [file a pull request](https://github.com/vercel/ai/pulls) to
+  add them to this list.
+</Note>
+
+## Learn more
+
+The AI SDK Core [Tool Calling](/docs/ai-sdk-core/tools-and-tool-calling)
+and [Agents](/docs/foundations/agents) documentation has more information about tools and tool calling.

package/docs/02-foundations/05-streaming.mdx

@@ -0,0 +1,62 @@
+---
+title: Streaming
+description: Why use streaming for AI applications?
+---
+
+# Streaming
+
+Streaming conversational text UIs (like ChatGPT) have gained massive popularity over the past few months. This section explores the benefits and drawbacks of streaming and blocking interfaces.
+
+[Large language models (LLMs)](/docs/foundations/overview#large-language-models) are extremely powerful. However, when generating long outputs, they can be very slow compared to the latency you're likely used to. If you try to build a traditional blocking UI, your users might easily find themselves staring at loading spinners for 5, 10, even up to 40s waiting for the entire LLM response to be generated. This can lead to a poor user experience, especially in conversational applications like chatbots. Streaming UIs can help mitigate this issue by **displaying parts of the response as they become available**.
+
+<div className="grid lg:grid-cols-2 grid-cols-1 gap-4 mt-8">
+  <Card
+    title="Blocking UI"
+    description="Blocking responses wait until the full response is available before displaying it."
+  >
+    <BrowserIllustration highlight blocking />
+  </Card>
+  <Card
+    title="Streaming UI"
+    description="Streaming responses can transmit parts of the response as they become available."
+  >
+    <BrowserIllustration highlight />
+  </Card>
+</div>
+
+## Real-world Examples
+
+Here are 2 examples that illustrate how streaming UIs can improve user experiences in a real-world setting – the first uses a blocking UI, while the second uses a streaming UI.
+
+### Blocking UI
+
+<InlinePrompt
+  initialInput="Come up with the first 200 characters of the first book in the Harry Potter series."
+  blocking
+/>
+
+### Streaming UI
+
+<InlinePrompt initialInput="Come up with the first 200 characters of the first book in the Harry Potter series." />
+
+As you can see, the streaming UI is able to start displaying the response much faster than the blocking UI. This is because the blocking UI has to wait for the entire response to be generated before it can display anything, while the streaming UI can display parts of the response as they become available.
+
+While streaming interfaces can greatly enhance user experiences, especially with larger language models, they aren't always necessary or beneficial. If you can achieve your desired functionality using a smaller, faster model without resorting to streaming, this route can often lead to simpler and more manageable development processes.
+
+However, regardless of the speed of your model, the AI SDK is designed to make implementing streaming UIs as simple as possible. In the example below, we stream text generation from OpenAI's `gpt-4.1` in under 10 lines of code using the SDK's [`streamText`](/docs/reference/ai-sdk-core/stream-text) function:
+
+```ts
+import { streamText } from 'ai';
+__PROVIDER_IMPORT__;
+
+const { textStream } = streamText({
+  model: __MODEL__,
+  prompt: 'Write a poem about embedding models.',
+});
+
+for await (const textPart of textStream) {
+  console.log(textPart);
+}
+```
+
+For an introduction to streaming UIs and the AI SDK, check out our [Getting Started guides](/docs/getting-started).

package/docs/02-foundations/index.mdx

@@ -0,0 +1,43 @@
+---
+title: Foundations
+description: A section that covers foundational knowledge around LLMs and concepts crucial to the AI SDK
+---
+
+# Foundations
+
+<IndexCards
+  cards={[
+    {
+      title: 'Overview',
+      description: 'Learn about foundational concepts around AI and LLMs.',
+      href: '/docs/foundations/overview',
+    },
+    {
+      title: 'Providers and Models',
+      description:
+        'Learn about the providers and models that you can use with the AI SDK.',
+      href: '/docs/foundations/providers-and-models',
+    },
+    {
+      title: 'Prompts',
+      description:
+        'Learn about how Prompts are used and defined in the AI SDK.',
+      href: '/docs/foundations/prompts',
+    },
+    {
+      title: 'Tools',
+      description: 'Learn about tools in the AI SDK.',
+      href: '/docs/foundations/tools',
+    },
+    {
+      title: 'Streaming',
+      description: 'Learn why streaming is used for AI applications.',
+      href: '/docs/foundations/streaming',
+    },
+    {
+      title: 'Agents',
+      description: 'Learn how to build agents with the AI SDK.',
+      href: '/docs/foundations/agents',
+    },
+  ]}
+/>

package/docs/02-getting-started/00-choosing-a-provider.mdx

@@ -0,0 +1,110 @@
+---
+title: Choosing a Provider
+description: Learn how to configure and authenticate with AI providers in the AI SDK.
+---
+
+# Choosing a Provider
+
+The AI SDK supports dozens of model providers through [first-party](/providers/ai-sdk-providers), [OpenAI-compatible](/providers/openai-compatible-providers), and [community](/providers/community-providers) packages.
+
+```ts
+import { generateText } from 'ai';
+__PROVIDER_IMPORT__;
+
+const { text } = await generateText({
+  model: __MODEL__,
+  prompt: 'What is love?',
+});
+```
+
+## AI Gateway
+
+The [Vercel AI Gateway](/providers/ai-sdk-providers/ai-gateway) is the fastest way to get started with the AI SDK. Access models from OpenAI, Anthropic, Google, and other providers. Authenticate with [OIDC](https://ai-sdk.dev/providers/ai-sdk-providers/ai-gateway#oidc-authentication-vercel-deployments) or an AI Gateway API key
+
+<div className="max-w-[40%] mx-auto">
+  <ButtonLink
+    href="https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fai%2Fapi-keys%3Futm_source%3Dgateway-models-page%26showCreateKeyModal%3Dtrue&title=Get+Started+with+Vercel+AI+Gateway"
+    shape="rounded"
+    size="large"
+    type="default"
+    prefix={<VercelIcon />}
+  >
+    Get an API Key
+  </ButtonLink>
+</div>
+
+Add your API key to your environment:
+
+```env filename=".env.local"
+AI_GATEWAY_API_KEY=your_api_key_here
+```
+
+The AI Gateway is the default [global provider](/docs/ai-sdk-core/provider-management#global-provider-configuration), so you can access models using a simple string:
+
+```ts
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: 'anthropic/claude-sonnet-4.5',
+  prompt: 'What is love?',
+});
+```
+
+You can also explicitly import and use the gateway provider:
+
+```ts
+// Option 1: Import from 'ai' package (included by default)
+import { gateway } from 'ai';
+model: gateway('anthropic/claude-sonnet-4.5');
+
+// Option 2: Install and import from '@ai-sdk/gateway' package
+import { gateway } from '@ai-sdk/gateway';
+model: gateway('anthropic/claude-sonnet-4.5');
+```
+
+## Using Dedicated Providers
+
+You can also use [first-party](/providers/ai-sdk-providers), [OpenAI-compatible](/providers/openai-compatible-providers), and [community](/providers/community-providers) provider packages directly. Install the package and create a provider instance. For example, to use Anthropic:
+
+<div className="my-4">
+  <Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+    <Tab>
+      <Snippet text="pnpm add @ai-sdk/anthropic" dark />
+    </Tab>
+    <Tab>
+      <Snippet text="npm install @ai-sdk/anthropic" dark />
+    </Tab>
+    <Tab>
+      <Snippet text="yarn add @ai-sdk/anthropic" dark />
+    </Tab>
+    <Tab>
+      <Snippet text="bun add @ai-sdk/anthropic" dark />
+    </Tab>
+  </Tabs>
+</div>
+
+```ts
+import { anthropic } from '@ai-sdk/anthropic';
+
+model: anthropic('claude-sonnet-4-5');
+```
+
+You can change the default global provider so string model references use your preferred provider everywhere in your application. Learn more about [provider management](/docs/ai-sdk-core/provider-management#global-provider-configuration).
+
+See [available providers](/providers/ai-sdk-providers) for setup instructions for each provider.
+
+## Custom Providers
+
+You can build your own provider to integrate any service with the AI SDK. The AI SDK provides a [Language Model Specification](https://github.com/vercel/ai/tree/main/packages/provider/src/language-model/v3) that ensures compatibility across providers.
+
+```ts
+import { generateText } from 'ai';
+import { yourProvider } from 'your-custom-provider';
+
+const { text } = await generateText({
+  model: yourProvider('your-model-id'),
+  prompt: 'What is love?',
+});
+```
+
+See [Writing a Custom Provider](/providers/community-providers/custom-providers) for a complete guide.

package/docs/02-getting-started/01-navigating-the-library.mdx

@@ -0,0 +1,85 @@
+---
+title: Navigating the Library
+description: Learn how to navigate the AI SDK.
+---
+
+# Navigating the Library
+
+The AI SDK is a powerful toolkit for building AI applications. This page will help you pick the right tools for your requirements.
+
+Let’s start with a quick overview of the AI SDK, which is comprised of three parts:
+
+- **[AI SDK Core](/docs/ai-sdk-core/overview):** A unified, provider agnostic API for generating text, structured objects, and tool calls with LLMs.
+- **[AI SDK UI](/docs/ai-sdk-ui/overview):** A set of framework-agnostic hooks for building chat and generative user interfaces.
+- [AI SDK RSC](/docs/ai-sdk-rsc/overview): Stream generative user interfaces with React Server Components (RSC). Development is currently experimental and we recommend using [AI SDK UI](/docs/ai-sdk-ui/overview).
+
+## Choosing the Right Tool for Your Environment
+
+When deciding which part of the AI SDK to use, your first consideration should be the environment and existing stack you are working with. Different components of the SDK are tailored to specific frameworks and environments.
+
+| Library                                   | Purpose                                                                                                                                                                                                  | Environment Compatibility                                          |
+| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [AI SDK Core](/docs/ai-sdk-core/overview) | Call any LLM with unified API (e.g. [generateText](/docs/reference/ai-sdk-core/generate-text) and [generateObject](/docs/reference/ai-sdk-core/generate-object))                                         | Any JS environment (e.g. Node.js, Deno, Browser)                   |
+| [AI SDK UI](/docs/ai-sdk-ui/overview)     | Build streaming chat and generative UIs (e.g. [useChat](/docs/reference/ai-sdk-ui/use-chat))                                                                                                             | React & Next.js, Vue & Nuxt, Svelte & SvelteKit                    |
+| [AI SDK RSC](/docs/ai-sdk-rsc/overview)   | Stream generative UIs from Server to Client (e.g. [streamUI](/docs/reference/ai-sdk-rsc/stream-ui)). Development is currently experimental and we recommend using [AI SDK UI](/docs/ai-sdk-ui/overview). | Any framework that supports React Server Components (e.g. Next.js) |
+
+## Environment Compatibility
+
+These tools have been designed to work seamlessly with each other and it's likely that you will be using them together. Let's look at how you could decide which libraries to use based on your application environment, existing stack, and requirements.
+
+The following table outlines AI SDK compatibility based on environment:
+
+| Environment           | [AI SDK Core](/docs/ai-sdk-core/overview) | [AI SDK UI](/docs/ai-sdk-ui/overview) | [AI SDK RSC](/docs/ai-sdk-rsc/overview) |
+| --------------------- | ----------------------------------------- | ------------------------------------- | --------------------------------------- |
+| None / Node.js / Deno | <Check size={18} />                       | <Cross size={18} />                   | <Cross size={18} />                     |
+| Vue / Nuxt            | <Check size={18} />                       | <Check size={18} />                   | <Cross size={18} />                     |
+| Svelte / SvelteKit    | <Check size={18} />                       | <Check size={18} />                   | <Cross size={18} />                     |
+| Next.js Pages Router  | <Check size={18} />                       | <Check size={18} />                   | <Cross size={18} />                     |
+| Next.js App Router    | <Check size={18} />                       | <Check size={18} />                   | <Check size={18} />                     |
+
+## When to use AI SDK UI
+
+AI SDK UI provides a set of framework-agnostic hooks for quickly building **production-ready AI-native applications**. It offers:
+
+- Full support for streaming chat and client-side generative UI
+- Utilities for handling common AI interaction patterns (i.e. chat, completion, assistant)
+- Production-tested reliability and performance
+- Compatibility across popular frameworks
+
+## AI SDK UI Framework Compatibility
+
+AI SDK UI supports the following frameworks: [React](https://react.dev/), [Svelte](https://svelte.dev/), and [Vue.js](https://vuejs.org/). Here is a comparison of the supported functions across these frameworks:
+
+| Function                                                   | React               | Svelte              | Vue.js              |
+| ---------------------------------------------------------- | ------------------- | ------------------- | ------------------- |
+| [useChat](/docs/reference/ai-sdk-ui/use-chat)              | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| [useChat](/docs/reference/ai-sdk-ui/use-chat) tool calling | <Check size={18} /> | <Check size={18} /> | <Cross size={18} /> |
+| [useCompletion](/docs/reference/ai-sdk-ui/use-completion)  | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| [useObject](/docs/reference/ai-sdk-ui/use-object)          | <Check size={18} /> | <Cross size={18} /> | <Cross size={18} /> |
+
+<Note>
+  [Contributions](https://github.com/vercel/ai/blob/main/CONTRIBUTING.md) are
+  welcome to implement missing features for non-React frameworks.
+</Note>
+
+## When to use AI SDK RSC
+
+<Note type="warning">
+  AI SDK RSC is currently experimental. We recommend using [AI SDK
+  UI](/docs/ai-sdk-ui/overview) for production. For guidance on migrating from
+  RSC to UI, see our [migration guide](/docs/ai-sdk-rsc/migrating-to-ui).
+</Note>
+
+[React Server Components](https://nextjs.org/docs/app/building-your-application/rendering/server-components)
+(RSCs) provide a new approach to building React applications that allow components
+to render on the server, fetch data directly, and stream the results to the client,
+reducing bundle size and improving performance. They also introduce a new way to
+call server-side functions from anywhere in your application called [Server Actions](https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations).
+
+AI SDK RSC provides a number of utilities that allow you to stream values and UI directly from the server to the client. However, **it's important to be aware of current limitations**:
+
+- **Cancellation**: currently, it is not possible to abort a stream using Server Actions. This will be improved in future releases of React and Next.js.
+- **Increased Data Transfer**: using [`createStreamableUI`](/docs/reference/ai-sdk-rsc/create-streamable-ui) can lead to quadratic data transfer (quadratic to the length of generated text). You can avoid this using [ `createStreamableValue` ](/docs/reference/ai-sdk-rsc/create-streamable-value) instead, and rendering the component client-side.
+- **Re-mounting Issue During Streaming**: when using `createStreamableUI`, components re-mount on `.done()`, causing [flickering](https://github.com/vercel/ai/issues/2232).
+
+Given these limitations, **we recommend using [AI SDK UI](/docs/ai-sdk-ui/overview) for production applications**.