ai 2.2.37 → 3.0.1

package/README.md

@@ -4,6 +4,7 @@ The Vercel AI SDK is **a library for building AI-powered streaming text and chat
 
 ## Features
 
+- React Server Components API for streaming Generative UI
 - [SWR](https://swr.vercel.app)-powered React, Svelte, Vue and Solid helpers for streaming text responses and building chat and completion UIs
 - First-class support for [LangChain](https://js.langchain.com/docs) and [OpenAI](https://openai.com), [Anthropic](https://www.anthropic.com), [Cohere](https://cohere.com), [Hugging Face](https://huggingface.co), [Fireworks](https://app.fireworks.ai) and [Replicate](https://replicate.com)
 - Node.js, Serverless, and [Edge Runtime](https://edge-runtime.vercel.app/) support
@@ -15,66 +16,6 @@ The Vercel AI SDK is **a library for building AI-powered streaming text and chat
 pnpm install ai
 ```
 
-View the full documentation and examples on [sdk.vercel.ai/docs](https://sdk.vercel.ai/docs)
-
-## Example: An AI Chatbot with Next.js and OpenAI
-
-With the Vercel AI SDK, you can build a ChatGPT-like app in just a few lines of code:
-
-```tsx
-// ./app/api/chat/route.js
-import OpenAI from 'openai';
-import { OpenAIStream, StreamingTextResponse } from 'ai';
-
-const openai = new OpenAI({
-  apiKey: process.env.OPENAI_API_KEY,
-});
-
-export const runtime = 'edge';
-
-export async function POST(req) {
-  const { messages } = await req.json();
-  const response = await openai.chat.completions.create({
-    model: 'gpt-4',
-    stream: true,
-    messages,
-  });
-  const stream = OpenAIStream(response);
-  return new StreamingTextResponse(stream);
-}
-```
-
-```tsx
-// ./app/page.js
-'use client';
-
-import { useChat } from 'ai/react';
-
-export default function Chat() {
-  const { messages, input, handleInputChange, handleSubmit } = useChat();
-
-  return (
-    <div>
-      {messages.map(m => (
-        <div key={m.id}>
-          {m.role}: {m.content}
-        </div>
-      ))}
-
-      <form onSubmit={handleSubmit}>
-        <input
-          value={input}
-          placeholder="Say something..."
-          onChange={handleInputChange}
-        />
-      </form>
-    </div>
-  );
-}
-```
-
----
-
 View the full documentation and examples on [sdk.vercel.ai/docs](https://sdk.vercel.ai/docs).
 
 ## Authors

package/dist/index.d.ts

@@ -602,6 +602,8 @@ interface AIStreamCallbacksAndOptions {
     onFinal?: (completion: string) => Promise<void> | void;
     /** `onToken`: Called for each tokenized message. */
     onToken?: (token: string) => Promise<void> | void;
+    /** `onText`: Called for each text chunk. */
+    onText?: (text: string) => Promise<void> | void;
     /**
      * A flag for enabling the experimental_StreamData class and the new protocol.
      * @see https://github.com/vercel-labs/ai/pull/425
@@ -626,14 +628,20 @@ interface AIStreamParserOptions {
  * @returns {string | void} The parsed data or void.
  */
 interface AIStreamParser {
-    (data: string, options: AIStreamParserOptions): string | void;
+    (data: string, options: AIStreamParserOptions): string | void | {
+        isText: false;
+        content: string;
+    };
 }
 /**
  * Creates a TransformStream that parses events from an EventSource stream using a custom parser.
  * @param {AIStreamParser} customParser - Function to handle event data.
  * @returns {TransformStream<Uint8Array, string>} TransformStream parsing events.
  */
-declare function createEventStreamTransformer(customParser?: AIStreamParser): TransformStream<Uint8Array, string>;
+declare function createEventStreamTransformer(customParser?: AIStreamParser): TransformStream<Uint8Array, string | {
+    isText: false;
+    content: string;
+}>;
 /**
  * Creates a transform stream that encodes input messages and invokes optional callback functions.
  * The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
@@ -656,7 +664,10 @@ declare function createEventStreamTransformer(customParser?: AIStreamParser): Tr
  * };
  * const transformer = createCallbacksTransformer(callbacks);
  */
-declare function createCallbacksTransformer(cb: AIStreamCallbacksAndOptions | OpenAIStreamCallbacks | undefined): TransformStream<string, Uint8Array>;
+declare function createCallbacksTransformer(cb: AIStreamCallbacksAndOptions | OpenAIStreamCallbacks | undefined): TransformStream<string | {
+    isText: false;
+    content: string;
+}, Uint8Array>;
 /**
  * Returns a stateful function that, when invoked, trims leading whitespace
  * from the input text. The trimming only occurs on the first invocation, ensuring that

package/dist/index.js

@@ -296,10 +296,14 @@ function createCallbacksTransformer(cb) {
         await callbacks.onStart();
     },
     async transform(message, controller) {
-      controller.enqueue(textEncoder.encode(message));
-      aggregatedResponse += message;
+      const content = typeof message === "string" ? message : message.content;
+      controller.enqueue(textEncoder.encode(content));
+      aggregatedResponse += content;
       if (callbacks.onToken)
-        await callbacks.onToken(message);
+        await callbacks.onToken(content);
+      if (callbacks.onText && typeof message === "string") {
+        await callbacks.onText(message);
+      }
     },
     async flush() {
       const isOpenAICallbacks = isOfTypeOpenAIStreamCallbacks(callbacks);
@@ -899,25 +903,46 @@ function chunkToText() {
       const delta = (_a = json.choices[0]) == null ? void 0 : _a.delta;
       if ((_b = delta.function_call) == null ? void 0 : _b.name) {
         isFunctionStreamingIn = true;
-        return `{"function_call": {"name": "${delta.function_call.name}", "arguments": "`;
+        return {
+          isText: false,
+          content: `{"function_call": {"name": "${delta.function_call.name}", "arguments": "`
+        };
       } else if ((_e = (_d = (_c = delta.tool_calls) == null ? void 0 : _c[0]) == null ? void 0 : _d.function) == null ? void 0 : _e.name) {
         isFunctionStreamingIn = true;
         const toolCall = delta.tool_calls[0];
         if (toolCall.index === 0) {
-          return `{"tool_calls":[ {"id": "${toolCall.id}", "type": "function", "function": {"name": "${(_f = toolCall.function) == null ? void 0 : _f.name}", "arguments": "`;
+          return {
+            isText: false,
+            content: `{"tool_calls":[ {"id": "${toolCall.id}", "type": "function", "function": {"name": "${(_f = toolCall.function) == null ? void 0 : _f.name}", "arguments": "`
+          };
         } else {
-          return `"}}, {"id": "${toolCall.id}", "type": "function", "function": {"name": "${(_g = toolCall.function) == null ? void 0 : _g.name}", "arguments": "`;
+          return {
+            isText: false,
+            content: `"}}, {"id": "${toolCall.id}", "type": "function", "function": {"name": "${(_g = toolCall.function) == null ? void 0 : _g.name}", "arguments": "`
+          };
         }
       } else if ((_h = delta.function_call) == null ? void 0 : _h.arguments) {
-        return cleanupArguments((_i = delta.function_call) == null ? void 0 : _i.arguments);
+        return {
+          isText: false,
+          content: cleanupArguments((_i = delta.function_call) == null ? void 0 : _i.arguments)
+        };
       } else if ((_l = (_k = (_j = delta.tool_calls) == null ? void 0 : _j[0]) == null ? void 0 : _k.function) == null ? void 0 : _l.arguments) {
-        return cleanupArguments((_o = (_n = (_m = delta.tool_calls) == null ? void 0 : _m[0]) == null ? void 0 : _n.function) == null ? void 0 : _o.arguments);
+        return {
+          isText: false,
+          content: cleanupArguments((_o = (_n = (_m = delta.tool_calls) == null ? void 0 : _m[0]) == null ? void 0 : _n.function) == null ? void 0 : _o.arguments)
+        };
       } else if (isFunctionStreamingIn && (((_p = json.choices[0]) == null ? void 0 : _p.finish_reason) === "function_call" || ((_q = json.choices[0]) == null ? void 0 : _q.finish_reason) === "stop")) {
         isFunctionStreamingIn = false;
-        return '"}}';
+        return {
+          isText: false,
+          content: '"}}'
+        };
       } else if (isFunctionStreamingIn && ((_r = json.choices[0]) == null ? void 0 : _r.finish_reason) === "tool_calls") {
         isFunctionStreamingIn = false;
-        return '"}}]}';
+        return {
+          isText: false,
+          content: '"}}]}'
+        };
       }
     }
     const text = trimStartOfStream(