ai 0.0.0-85f9a635-20240518005312 → 0.0.0-9477ebb9-20250403064906

package/README.md

@@ -1,37 +1,127 @@
-# Vercel AI SDK
+![hero illustration](./assets/hero.gif)
 
-The Vercel AI SDK is **a library for building AI-powered streaming text and chat UIs**.
+# AI SDK
 
-## Features
+The [AI SDK](https://sdk.vercel.ai/docs) is a TypeScript toolkit designed to help you build AI-powered applications using popular frameworks like Next.js, React, Svelte, Vue and runtimes like Node.js.
 
-- React, Svelte, Vue and Solid helpers for streaming text responses and building chat and completion UIs
-- React Server Components API for streaming [Generative UI](https://vercel.com/blog/ai-sdk-3-generative-ui)
-- First-class support for [OpenAI](https://openai.com), [Anthropic](https://www.anthropic.com), [Mistral](https://mistral.ai), [Perplexity](https://perplexity.ai), [AWS Bedrock](https://aws.amazon.com/bedrock/), [Azure](https://ai.azure.com), [Google Gemini](https://ai.google.dev), [Hugging Face](https://huggingface.co), [Fireworks](https://app.fireworks.ai), [Cohere](https://cohere.com), [LangChain](https://js.langchain.com/docs), [Replicate](https://replicate.com), Ollama, and more.
-- Node.js, Serverless, and [Edge Runtime](https://edge-runtime.vercel.app/) support
-- Lifecycle callbacks for saving completed streaming responses to a database (in the same request)
+To learn more about how to use the AI SDK, check out our [API Reference](https://sdk.vercel.ai/docs/reference) and [Documentation](https://sdk.vercel.ai/docs).
 
 ## Installation
 
-```sh
-pnpm install ai
+You will need Node.js 18+ and pnpm installed on your local development machine.
+
+```shell
+npm install ai
 ```
 
-View the full documentation and examples on [sdk.vercel.ai/docs](https://sdk.vercel.ai/docs).
+## Usage
 
-## Authors
+### AI SDK Core
+
+The [AI SDK Core](https://sdk.vercel.ai/docs/ai-sdk-core/overview) module provides a unified API to interact with model providers like [OpenAI](https://sdk.vercel.ai/providers/ai-sdk-providers/openai), [Anthropic](https://sdk.vercel.ai/providers/ai-sdk-providers/anthropic), [Google](https://sdk.vercel.ai/providers/ai-sdk-providers/google-generative-ai), and more.
+
+You will then install the model provider of your choice.
+
+```shell
+npm install @ai-sdk/openai
+```
+
+###### @/index.ts (Node.js Runtime)
+
+```ts
+import { generateText } from 'ai';
+import { openai } from '@ai-sdk/openai'; // Ensure OPENAI_API_KEY environment variable is set
+
+const { text } = await generateText({
+  model: openai('gpt-4o'),
+  system: 'You are a friendly assistant!',
+  prompt: 'Why is the sky blue?',
+});
+
+console.log(text);
+```
+
+### AI SDK UI
+
+The [AI SDK UI](https://sdk.vercel.ai/docs/ai-sdk-ui/overview) 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:
+
+```shell
+npm install @ai-sdk/react
+```
+
+###### @/app/page.tsx (Next.js App Router)
 
-This library is created by [Vercel](https://vercel.com) and [Next.js](https://nextjs.org) team members, with contributions from:
+```tsx
+'use client';
 
-- Jared Palmer ([@jaredpalmer](https://twitter.com/jaredpalmer)) - [Vercel](https://vercel.com)
-- Shu Ding ([@shuding\_](https://twitter.com/shuding_)) - [Vercel](https://vercel.com)
-- Max Leiter ([@max_leiter](https://twitter.com/max_leiter)) - [Vercel](https://vercel.com)
-- Malte Ubl ([@cramforce](https://twitter.com/cramforce)) - [Vercel](https://vercel.com)
-- Justin Ridgewell ([@jridgewell](https://github.com/jridgewell))
+import { useChat } from '@ai-sdk/react';
 
-[Contributors](https://github.com/vercel/ai/graphs/contributors)
+export default function Page() {
+  const { messages, input, handleSubmit, handleInputChange, status } =
+    useChat();
 
-## Related: Deploy your own Next.js AI Chatbot
+  return (
+    <div>
+      {messages.map(message => (
+        <div key={message.id}>
+          <strong>{`${message.role}: `}</strong>
+          {message.parts.map((part, index) => {
+            switch (part.type) {
+              case 'text':
+                return <span key={index}>{part.text}</span>;
 
-If you're looking to for a full AI Chatbot application to jumpstart your AI journey, you should checkout [our sister OSS AI Chatbot project](https://github.com/vercel/ai-chatbot) or click the button below to deploy your own to [Vercel](https://vercel.com).
+              // other cases can handle images, tool calls, etc
+            }
+          })}
+        </div>
+      ))}
+
+      <form onSubmit={handleSubmit}>
+        <input
+          value={input}
+          placeholder="Send a message..."
+          onChange={handleInputChange}
+          disabled={status !== 'ready'}
+        />
+      </form>
+    </div>
+  );
+}
+```
+
+###### @/app/api/chat/route.ts (Next.js App Router)
+
+```ts
+import { streamText } from 'ai';
+import { openai } from '@ai-sdk/openai';
+
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+
+  const result = streamText({
+    model: openai('gpt-4o'),
+    system: 'You are a helpful assistant.',
+    messages,
+  });
+
+  return result.toDataStreamResponse();
+}
+```
+
+## Templates
+
+We've built [templates](https://vercel.com/templates?type=ai) 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 [GitHub Discussions](https://github.com/vercel/ai/discussions) 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](https://github.com/vercel/ai/blob/main/CONTRIBUTING.md) to make sure you have smooth experience contributing to AI SDK.
+
+## Authors
 
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/templates/Next.js/nextjs-ai-chatbot)
+This library is created by [Vercel](https://vercel.com) and [Next.js](https://nextjs.org) team members, with contributions from the [Open Source Community](https://github.com/vercel/ai/graphs/contributors).