ai 3.2.36 → 3.2.38

package/README.md

@@ -97,7 +97,7 @@ export async function POST(req: Request) {
     messages,
   });
 
-  return result.toAIStreamResponse();
+  return result.toDataStreamamResponse();
 }
 ```
 

package/dist/index.d.mts

@@ -34,7 +34,7 @@ Represents the number of tokens used in a prompt and completion.
  */
 type CompletionTokenUsage$1 = {
     /**
-  The number of tokens used in the prompt
+  The number of tokens used in the prompt.
      */
     promptTokens: number;
     /**
@@ -1281,7 +1281,9 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     @param callbacks
     Stream callbacks that will be called when the stream emits events.
   
-    @returns an `AIStream` object.
+    @returns A data stream.
+  
+    @deprecated Use `toDataStreamResponse` instead.
        */
     toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
@@ -1291,12 +1293,26 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @param response A Node.js response-like object (ServerResponse).
     @param init Optional headers and status code.
+  
+    @deprecated Use `pipeDataStreamToResponse` instead.
        */
     pipeAIStreamToResponse(response: ServerResponse$1, init?: {
         headers?: Record<string, string>;
         status?: number;
     }): void;
     /**
+    Writes data stream output to a Node.js response-like object.
+    It sets a `Content-Type` header to `text/plain; charset=utf-8` and
+    writes each data stream part as a separate chunk.
+  
+    @param response A Node.js response-like object (ServerResponse).
+    @param init Optional headers and status code.
+       */
+    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
+    /**
     Writes text delta output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
     writes each text delta as a separate chunk.
@@ -1316,12 +1332,27 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     You can also pass in a ResponseInit directly (deprecated).
   
     @return A response object.
+  
+    @deprecated Use `toDataStreamResponse` instead.
        */
     toAIStreamResponse(options?: ResponseInit | {
         init?: ResponseInit;
         data?: StreamData;
     }): Response;
     /**
+    Converts the result to a streamed response object with a stream data part stream.
+    It can be used with the `useChat` and `useCompletion` hooks.
+  
+    @param options An object with an init property (ResponseInit) and a data property.
+    You can also pass in a ResponseInit directly (deprecated).
+  
+    @return A response object.
+       */
+    toDataStreamResponse(options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+    }): Response;
+    /**
     Creates a simple text stream response.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
@@ -1498,6 +1529,10 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
         headers?: Record<string, string>;
         status?: number;
     }): void;
+    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
     pipeTextStreamToResponse(response: ServerResponse$1, init?: {
         headers?: Record<string, string>;
         status?: number;
@@ -1506,6 +1541,10 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
         init?: ResponseInit;
         data?: StreamData;
     }): Response;
+    toDataStreamResponse(options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+    }): Response;
     toTextStreamResponse(init?: ResponseInit): Response;
 }
 /**
@@ -2215,13 +2254,25 @@ Converts LangChain output streams to AIStream.
 The following streams are supported:
 - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
 - `string` streams (LangChain `StringOutputParser` output)
+
+@deprecated Use `toDataStream` instead.
  */
 declare function toAIStream(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+/**
+Converts LangChain output streams to AIStream.
+
+The following streams are supported:
+- `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
+- `string` streams (LangChain `StringOutputParser` output)
+ */
+declare function toDataStream(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
 
 declare const langchainAdapter_toAIStream: typeof toAIStream;
+declare const langchainAdapter_toDataStream: typeof toDataStream;
 declare namespace langchainAdapter {
   export {
     langchainAdapter_toAIStream as toAIStream,
+    langchainAdapter_toDataStream as toDataStream,
   };
 }
 
@@ -2353,6 +2404,8 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse$
 
 /**
  * A utility class for streaming text responses.
+ *
+ * @deprecated Use `streamText.toDataStreamResponse()` instead.
  */
 declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);

package/dist/index.d.ts

@@ -34,7 +34,7 @@ Represents the number of tokens used in a prompt and completion.
  */
 type CompletionTokenUsage$1 = {
     /**
-  The number of tokens used in the prompt
+  The number of tokens used in the prompt.
      */
     promptTokens: number;
     /**
@@ -1281,7 +1281,9 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     @param callbacks
     Stream callbacks that will be called when the stream emits events.
   
-    @returns an `AIStream` object.
+    @returns A data stream.
+  
+    @deprecated Use `toDataStreamResponse` instead.
        */
     toAIStream(callbacks?: AIStreamCallbacksAndOptions): ReadableStream<Uint8Array>;
     /**
@@ -1291,12 +1293,26 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @param response A Node.js response-like object (ServerResponse).
     @param init Optional headers and status code.
+  
+    @deprecated Use `pipeDataStreamToResponse` instead.
        */
     pipeAIStreamToResponse(response: ServerResponse$1, init?: {
         headers?: Record<string, string>;
         status?: number;
     }): void;
     /**
+    Writes data stream output to a Node.js response-like object.
+    It sets a `Content-Type` header to `text/plain; charset=utf-8` and
+    writes each data stream part as a separate chunk.
+  
+    @param response A Node.js response-like object (ServerResponse).
+    @param init Optional headers and status code.
+       */
+    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
+    /**
     Writes text delta output to a Node.js response-like object.
     It sets a `Content-Type` header to `text/plain; charset=utf-8` and
     writes each text delta as a separate chunk.
@@ -1316,12 +1332,27 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     You can also pass in a ResponseInit directly (deprecated).
   
     @return A response object.
+  
+    @deprecated Use `toDataStreamResponse` instead.
        */
     toAIStreamResponse(options?: ResponseInit | {
         init?: ResponseInit;
         data?: StreamData;
     }): Response;
     /**
+    Converts the result to a streamed response object with a stream data part stream.
+    It can be used with the `useChat` and `useCompletion` hooks.
+  
+    @param options An object with an init property (ResponseInit) and a data property.
+    You can also pass in a ResponseInit directly (deprecated).
+  
+    @return A response object.
+       */
+    toDataStreamResponse(options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+    }): Response;
+    /**
     Creates a simple text stream response.
     Each text delta is encoded as UTF-8 and sent as a separate chunk.
     Non-text-delta events are ignored.
@@ -1498,6 +1529,10 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
         headers?: Record<string, string>;
         status?: number;
     }): void;
+    pipeDataStreamToResponse(response: ServerResponse$1, init?: {
+        headers?: Record<string, string>;
+        status?: number;
+    }): void;
     pipeTextStreamToResponse(response: ServerResponse$1, init?: {
         headers?: Record<string, string>;
         status?: number;
@@ -1506,6 +1541,10 @@ declare class DefaultStreamTextResult<TOOLS extends Record<string, CoreTool>> im
         init?: ResponseInit;
         data?: StreamData;
     }): Response;
+    toDataStreamResponse(options?: ResponseInit | {
+        init?: ResponseInit;
+        data?: StreamData;
+    }): Response;
     toTextStreamResponse(init?: ResponseInit): Response;
 }
 /**
@@ -2215,13 +2254,25 @@ Converts LangChain output streams to AIStream.
 The following streams are supported:
 - `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
 - `string` streams (LangChain `StringOutputParser` output)
+
+@deprecated Use `toDataStream` instead.
  */
 declare function toAIStream(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
+/**
+Converts LangChain output streams to AIStream.
+
+The following streams are supported:
+- `LangChainAIMessageChunk` streams (LangChain `model.stream` output)
+- `string` streams (LangChain `StringOutputParser` output)
+ */
+declare function toDataStream(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream<any>;
 
 declare const langchainAdapter_toAIStream: typeof toAIStream;
+declare const langchainAdapter_toDataStream: typeof toDataStream;
 declare namespace langchainAdapter {
   export {
     langchainAdapter_toAIStream as toAIStream,
+    langchainAdapter_toDataStream as toDataStream,
   };
 }
 
@@ -2353,6 +2404,8 @@ declare function streamToResponse(res: ReadableStream, response: ServerResponse$
 
 /**
  * A utility class for streaming text responses.
+ *
+ * @deprecated Use `streamText.toDataStreamResponse()` instead.
  */
 declare class StreamingTextResponse extends Response {
     constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData);

package/dist/index.js

@@ -978,12 +978,18 @@ function calculateCompletionTokenUsage(usage) {
 }
 
 // core/util/prepare-response-headers.ts
-function prepareResponseHeaders(init, { contentType }) {
+function prepareResponseHeaders(init, {
+  contentType,
+  dataStreamVersion
+}) {
   var _a;
   const headers = new Headers((_a = init == null ? void 0 : init.headers) != null ? _a : {});
   if (!headers.has("Content-Type")) {
     headers.set("Content-Type", contentType);
   }
+  if (dataStreamVersion !== void 0) {
+    headers.set("X-Vercel-AI-Data-Stream", dataStreamVersion);
+  }
   return headers;
 }
 
@@ -1076,7 +1082,6 @@ async function generateObject({
     },
     tracer,
     fn: async (span) => {
-      var _a2, _b;
       const retry = retryWithExponentialBackoff({ maxRetries });
       if (mode === "auto" || mode == null) {
         mode = model.defaultObjectGenerationMode;
@@ -1121,20 +1126,20 @@ async function generateObject({
                   abortSignal,
                   headers
                 });
+                if (result2.text === void 0) {
+                  throw new import_provider6.NoObjectGeneratedError();
+                }
                 span2.setAttributes({
                   "ai.finishReason": result2.finishReason,
                   "ai.usage.promptTokens": result2.usage.promptTokens,
                   "ai.usage.completionTokens": result2.usage.completionTokens,
-                  "ai.result.text": result2.text
+                  "ai.result.object": result2.text
                 });
-                return result2;
+                return { ...result2, objectText: result2.text };
               }
             })
           );
-          if (generateResult.text === void 0) {
-            throw new import_provider6.NoObjectGeneratedError();
-          }
-          result = generateResult.text;
+          result = generateResult.objectText;
           finishReason = generateResult.finishReason;
           usage = generateResult.usage;
           warnings = generateResult.warnings;
@@ -1164,6 +1169,7 @@ async function generateObject({
               },
               tracer,
               fn: async (span2) => {
+                var _a2, _b;
                 const result2 = await model.doGenerate({
                   mode: {
                     type: "object-tool",
@@ -1180,22 +1186,21 @@ async function generateObject({
                   abortSignal,
                   headers
                 });
+                const objectText = (_b = (_a2 = result2.toolCalls) == null ? void 0 : _a2[0]) == null ? void 0 : _b.args;
+                if (objectText === void 0) {
+                  throw new import_provider6.NoObjectGeneratedError();
+                }
                 span2.setAttributes({
                   "ai.finishReason": result2.finishReason,
                   "ai.usage.promptTokens": result2.usage.promptTokens,
                   "ai.usage.completionTokens": result2.usage.completionTokens,
-                  "ai.result.text": result2.text,
-                  "ai.result.toolCalls": JSON.stringify(result2.toolCalls)
+                  "ai.result.object": objectText
                 });
-                return result2;
+                return { ...result2, objectText };
               }
             })
           );
-          const functionArgs = (_b = (_a2 = generateResult.toolCalls) == null ? void 0 : _a2[0]) == null ? void 0 : _b.args;
-          if (functionArgs === void 0) {
-            throw new import_provider6.NoObjectGeneratedError();
-          }
-          result = functionArgs;
+          result = generateResult.objectText;
           finishReason = generateResult.finishReason;
           usage = generateResult.usage;
           warnings = generateResult.warnings;
@@ -2568,6 +2573,15 @@ var DefaultStreamTextResult = class {
             );
             break;
           case "finish":
+            controller.enqueue(
+              (0, import_ui_utils6.formatStreamPart)("finish_message", {
+                finishReason: chunk.finishReason,
+                usage: {
+                  promptTokens: chunk.usage.promptTokens,
+                  completionTokens: chunk.usage.completionTokens
+                }
+              })
+            );
             break;
           default: {
             const exhaustiveCheck = chunkType;
@@ -2579,6 +2593,9 @@ var DefaultStreamTextResult = class {
     return this.fullStream.pipeThrough(callbackTransformer).pipeThrough(streamPartsTransformer).pipeThrough(new TextEncoderStream());
   }
   pipeAIStreamToResponse(response, init) {
+    return this.pipeDataStreamToResponse(response, init);
+  }
+  pipeDataStreamToResponse(response, init) {
     var _a;
     response.writeHead((_a = init == null ? void 0 : init.status) != null ? _a : 200, {
       "Content-Type": "text/plain; charset=utf-8",
@@ -2625,6 +2642,9 @@ var DefaultStreamTextResult = class {
     read();
   }
   toAIStreamResponse(options) {
+    return this.toDataStreamResponse(options);
+  }
+  toDataStreamResponse(options) {
     var _a;
     const init = options == null ? void 0 : "init" in options ? options.init : {
       headers: "headers" in options ? options.headers : void 0,
@@ -2637,7 +2657,8 @@ var DefaultStreamTextResult = class {
       status: (_a = init == null ? void 0 : init.status) != null ? _a : 200,
       statusText: init == null ? void 0 : init.statusText,
       headers: prepareResponseHeaders(init, {
-        contentType: "text/plain; charset=utf-8"
+        contentType: "text/plain; charset=utf-8",
+        dataStreamVersion: "v1"
       })
     });
   }
@@ -3454,9 +3475,13 @@ function InkeepStream(res, callbacks) {
 // streams/langchain-adapter.ts
 var langchain_adapter_exports = {};
 __export(langchain_adapter_exports, {
-  toAIStream: () => toAIStream
+  toAIStream: () => toAIStream,
+  toDataStream: () => toDataStream
 });
 function toAIStream(stream, callbacks) {
+  return toDataStream(stream, callbacks);
+}
+function toDataStream(stream, callbacks) {
   return stream.pipeThrough(
     new TransformStream({
       transform: async (value, controller) => {