ai README

The project's README from github.com/vercel/ai. As one markdown file: README.md.

hero illustration

AI SDK

The AI SDK is a provider-agnostic TypeScript toolkit designed to help you build AI-powered applications and agents using popular UI frameworks like Next.js, React, Svelte, Vue, Angular, and runtimes like Node.js.

To learn more about how to use the AI SDK, check out our API Reference and Documentation.

Installation

You will need Node.js 22+ and npm (or another package manager) installed on your local development machine.

npm install ai

Skill for Coding Agents

If you use coding agents such as Claude Code or Cursor, we highly recommend adding the AI SDK skill to your repository:

npx skills add vercel/ai

Unified Provider Architecture

The AI SDK provides a unified API to interact with model providers like OpenAI, Anthropic, Google, and more.

By default, the AI SDK uses the Vercel AI Gateway to give you access to all major providers out of the box. Just pass a model string for any supported model:

const result = await generateText({
  model: 'anthropic/claude-opus-4.6', // or 'openai/gpt-5.4', 'google/gemini-3-flash', etc.
  prompt: 'Hello!',
});

You can also connect to providers directly using their SDK packages:

npm install @ai-sdk/openai @ai-sdk/anthropic @ai-sdk/google

import { anthropic } from '@ai-sdk/anthropic';

const result = await generateText({
  model: anthropic('claude-opus-4-6'), // or openai('gpt-5.4'), google('gemini-3-flash'), etc.
  prompt: 'Hello!',
});

Usage

Generating Text

import { generateText } from 'ai';

const { text } = await generateText({
  model: 'openai/gpt-5.4', // use Vercel AI Gateway
  prompt: 'What is an agent?',
});

Generating Structured Data

import { generateText, Output } from 'ai';
import { z } from 'zod';

const { output } = await generateText({
  model: 'openai/gpt-5.4',
  output: Output.object({
    schema: z.object({
      recipe: z.object({
        name: z.string(),
        ingredients: z.array(
          z.object({ name: z.string(), amount: z.string() }),
        ),
        steps: z.array(z.string()),
      }),
    }),
  }),
  prompt: 'Generate a lasagna recipe.',
});

Agents

import { ToolLoopAgent } from 'ai';

const sandboxAgent = new ToolLoopAgent({
  model: 'openai/gpt-5.4',
  system: 'You are an agent with access to a shell environment.',
  tools: {
    shell: openai.tools.localShell({
      execute: async ({ action }) => {
        const [cmd, ...args] = action.command;
        const sandbox = await getSandbox(); // Vercel Sandbox
        const command = await sandbox.runCommand({ cmd, args });
        return { output: await command.stdout() };
      },
    }),
  },
});

UI Integration

The AI SDK UI module provides a set of hooks that help you build chatbots and generative user interfaces. These hooks are framework agnostic, so they can be used in Next.js, React, Svelte, and Vue.

You need to install the package for your framework, e.g.:

npm install @ai-sdk/react

Agent @/agent/image-generation-agent.ts

import { openai } from '@ai-sdk/openai';
import { ToolLoopAgent, InferAgentUIMessage } from 'ai';

export const imageGenerationAgent = new ToolLoopAgent({
  model: 'openai/gpt-5.4',
  tools: {
    generateImage: openai.tools.imageGeneration({
      partialImages: 3,
    }),
  },
});

export type ImageGenerationAgentMessage = InferAgentUIMessage<
  typeof imageGenerationAgent
>;

Route (Next.js App Router) @/app/api/chat/route.ts

import { imageGenerationAgent } from '@/agent/image-generation-agent';
import { createAgentUIStreamResponse } from 'ai';

export async function POST(req: Request) {
  const { messages } = await req.json();

  return createAgentUIStreamResponse({
    agent: imageGenerationAgent,
    messages,
  });
}

UI Component for Tool @/component/image-generation-view.tsx

import { openai } from '@ai-sdk/openai';
import { UIToolInvocation } from 'ai';

export default function ImageGenerationView({
  invocation,
}: {
  invocation: UIToolInvocation<ReturnType<typeof openai.tools.imageGeneration>>;
}) {
  switch (invocation.state) {
    case 'input-available':
      return <div>Generating image...</div>;
    case 'output-available':
      return <img src={`data:image/png;base64,${invocation.output.result}`} />;
  }
}

Page @/app/page.tsx

'use client';

import { ImageGenerationAgentMessage } from '@/agent/image-generation-agent';
import ImageGenerationView from '@/component/image-generation-view';
import { useChat } from '@ai-sdk/react';

export default function Page() {
  const { messages, status, sendMessage } =
    useChat<ImageGenerationAgentMessage>();

  const [input, setInput] = useState('');
  const handleSubmit = e => {
    e.preventDefault();
    sendMessage({ text: input });
    setInput('');
  };

  return (
    <div>
      {messages.map(message => (
        <div key={message.id}>
          <strong>{`${message.role}: `}</strong>
          {message.parts.map((part, index) => {
            switch (part.type) {
              case 'text':
                return <div key={index}>{part.text}</div>;
              case 'tool-generateImage':
                return <ImageGenerationView key={index} invocation={part} />;
            }
          })}
        </div>
      ))}

      <form onSubmit={handleSubmit}>
        <input
          value={input}
          onChange={e => setInput(e.target.value)}
          disabled={status !== 'ready'}
        />
      </form>
    </div>
  );
}

Templates

We've built templates that include AI SDK integrations for different use cases, providers, and frameworks. You can use these templates to get started with your AI-powered application.

Community

The AI SDK community can be found on the Vercel Community where you can ask questions, voice ideas, and share your projects with other people.

Contributing

Contributions to the AI SDK are welcome and highly appreciated. However, before you jump right into it, we would like you to review our Contribution Guidelines to make sure you have smooth experience contributing to AI SDK.

Authors

This library is created by Vercel and Next.js team members, with contributions from the Open Source Community.

ai (vercel/ai)

Searching Database…

27.4K ·GitHub
Ai
Что это такое?Это AI SDK — бесплатный опенсорсный TypeScript-инструментарий от Vercel (команды Next.js) для создания приложений и агентов с ИИ на Next.js, React, Svelte, Vue, Angular и Node.js.
AI SDK — это фреймворк, внутри которого я строю приложение, или библиотека, которую я подключаю в свой код?Это библиотека, которую вы устанавливаете в свой TypeScript- или JavaScript-проект, а не отдельное приложение; вместе с основным пакетом поставляется UI-модуль с хуками.
Как добавить его в проект?Нужны Node.js 22+ и npm (или другой пакетный менеджер), затем установите SDK-пакет, подходящий для вашего случая. Если вы пишете код с Claude Code или Cursor, команда рекомендует добавить skill AI SDK в ваш репозиторий.
С какими ИИ-провайдерами он умеет работать?OpenAI, Anthropic, Google и другие крупные провайдеры работают через один единый API — обычно достаточно передать строку с названием модели. Вместо этого можно подключаться к провайдерам напрямую через их собственные SDK-пакеты.
Обязателен ли Vercel AI Gateway?Нет — шлюз просто задан по умолчанию и даёт доступ ко всем крупным провайдерам сразу из коробки. Можно также подключаться к провайдерам напрямую, используя их собственные SDK-пакеты.
Я пишу код с Claude Code или Cursor — есть ли что-то для агентных рабочих процессов?Да. Команда рекомендует добавлять skill AI SDK в ваш репозиторий при работе с агентами вроде Claude Code или Cursor, а сам SDK имеет первоклассную поддержку создания агентов.
Чем это лучше, чем напрямую использовать SDK от OpenAI или Anthropic?Провайдер-независимый API означает, что вы меняете модель, просто поменяв строку с её названием, а не переписывая код под конкретного провайдера, а Vercel AI Gateway по умолчанию даёт доступ ко всем крупным провайдерам сразу из коробки.
Как выглядит настоящее приложение, созданное с его помощью?В README разобран пример агента для генерации изображений: файл агента, API-роут в Next.js App Router, UI-компонент, который отображает результат работы инструмента, и страница, связывающая всё вместе.
What are similar projects?CopilotKit, openui, tambo, repomix, novel, boardui, OpenIntelligentUI, dyad
Which topics is it in?ai-sdk, tool-use, generative-ui, text-generation, ai-gateway, language-model, vercel, svelte, hooks, angular, nextjs, artificial-intelligence
Creator
vercel
Size
426.4 MB
Stars
27.4K
Updated
CommitOct 16Release@ai-sdk/[email protected]Oct 16
Age
3y
Commits · 90 Days