ai 6.0.59 → 6.0.60

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.60
+
+### Patch Changes
+
+- 5fc42fa: feat(ai): add experimental retention setting
+
 ## 6.0.59
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1074,7 +1074,7 @@ type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TO
  * @returns
  * A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, experimental_include: include, _internal: { generateId }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -1157,6 +1157,26 @@ declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Out
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Settings for controlling what data is included in step results.
+     * Disabling inclusion can help reduce memory usage when processing
+     * large payloads like images.
+     *
+     * By default, all data is included for backwards compatibility.
+     */
+    experimental_include?: {
+        /**
+         * Whether to retain the request body in step results.
+         * The request body can be large when sending images or files.
+         * @default true
+         */
+        requestBody?: boolean;
+        /**
+         * Whether to retain the response body in step results.
+         * @default true
+         */
+        responseBody?: boolean;
+    };
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -2402,7 +2422,7 @@ type StreamTextOnAbortCallback<TOOLS extends ToolSet> = (event: {
  * @returns
  * A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string, never>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string, never>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, experimental_include: include, _internal: { now, generateId }, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -2517,6 +2537,21 @@ declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Outpu
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Settings for controlling what data is included in step results.
+     * Disabling inclusion can help reduce memory usage when processing
+     * large payloads like images.
+     *
+     * By default, all data is included for backwards compatibility.
+     */
+    experimental_include?: {
+        /**
+         * Whether to retain the request body in step results.
+         * The request body can be large when sending images or files.
+         * @default true
+         */
+        requestBody?: boolean;
+    };
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.d.ts

@@ -1074,7 +1074,7 @@ type GenerateTextOnFinishCallback<TOOLS extends ToolSet> = (event: StepResult<TO
  * @returns
  * A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string>>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, experimental_include: include, _internal: { generateId }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -1157,6 +1157,26 @@ declare function generateText<TOOLS extends ToolSet, OUTPUT extends Output = Out
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Settings for controlling what data is included in step results.
+     * Disabling inclusion can help reduce memory usage when processing
+     * large payloads like images.
+     *
+     * By default, all data is included for backwards compatibility.
+     */
+    experimental_include?: {
+        /**
+         * Whether to retain the request body in step results.
+         * The request body can be large when sending images or files.
+         * @default true
+         */
+        requestBody?: boolean;
+        /**
+         * Whether to retain the response body in step results.
+         * @default true
+         */
+        responseBody?: boolean;
+    };
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -2402,7 +2422,7 @@ type StreamTextOnAbortCallback<TOOLS extends ToolSet> = (event: {
  * @returns
  * A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string, never>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Output<string, string, never>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, timeout, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, experimental_include: include, _internal: { now, generateId }, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -2517,6 +2537,21 @@ declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output = Outpu
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Settings for controlling what data is included in step results.
+     * Disabling inclusion can help reduce memory usage when processing
+     * large payloads like images.
+     *
+     * By default, all data is included for backwards compatibility.
+     */
+    experimental_include?: {
+        /**
+         * Whether to retain the request body in step results.
+         * The request body can be large when sending images or files.
+         * @default true
+         */
+        requestBody?: boolean;
+    };
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.js

@@ -1104,7 +1104,7 @@ var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.59" : "0.0.0-test";
+var VERSION = true ? "6.0.60" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -3850,6 +3850,7 @@ async function generateText({
   experimental_repairToolCall: repairToolCall,
   experimental_download: download2,
   experimental_context,
+  experimental_include: include,
   _internal: { generateId: generateId2 = originalGenerateId } = {},
   onStepFinish,
   onFinish,
@@ -3908,7 +3909,7 @@ async function generateText({
       }),
       tracer,
       fn: async (span) => {
-        var _a20, _b, _c, _d, _e, _f, _g, _h;
+        var _a20, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
         const initialMessages = initialPrompt.messages;
         const responseMessages = [];
         const { approvedToolApprovals, deniedToolApprovals } = collectToolApprovals({ messages: initialMessages });
@@ -4230,6 +4231,14 @@ async function generateText({
                 tools
               })
             );
+            const stepRequest = ((_g = include == null ? void 0 : include.requestBody) != null ? _g : true) ? (_h = currentModelResponse.request) != null ? _h : {} : { ...currentModelResponse.request, body: void 0 };
+            const stepResponse = {
+              ...currentModelResponse.response,
+              // deep clone msgs to avoid mutating past messages in multi-step:
+              messages: structuredClone(responseMessages),
+              // Conditionally include response body:
+              body: ((_i = include == null ? void 0 : include.responseBody) != null ? _i : true) ? (_j = currentModelResponse.response) == null ? void 0 : _j.body : void 0
+            };
             const currentStepResult = new DefaultStepResult({
               content: stepContent,
               finishReason: currentModelResponse.finishReason.unified,
@@ -4237,15 +4246,11 @@ async function generateText({
               usage: asLanguageModelUsage(currentModelResponse.usage),
               warnings: currentModelResponse.warnings,
               providerMetadata: currentModelResponse.providerMetadata,
-              request: (_g = currentModelResponse.request) != null ? _g : {},
-              response: {
-                ...currentModelResponse.response,
-                // deep clone msgs to avoid mutating past messages in multi-step:
-                messages: structuredClone(responseMessages)
-              }
+              request: stepRequest,
+              response: stepResponse
             });
             logWarnings({
-              warnings: (_h = currentModelResponse.warnings) != null ? _h : [],
+              warnings: (_k = currentModelResponse.warnings) != null ? _k : [],
               provider: stepModel.provider,
               model: stepModel.modelId
             });
@@ -5992,6 +5997,7 @@ function streamText({
   onAbort,
   onStepFinish,
   experimental_context,
+  experimental_include: include,
   _internal: { now: now2 = now, generateId: generateId2 = originalGenerateId2 } = {},
   ...settings
 }) {
@@ -6037,7 +6043,8 @@ function streamText({
     now: now2,
     generateId: generateId2,
     experimental_context,
-    download: download2
+    download: download2,
+    include
   });
 }
 function createOutputTransformStream(output) {
@@ -6135,7 +6142,8 @@ var DefaultStreamTextResult = class {
     onAbort,
     onStepFinish,
     experimental_context,
-    download: download2
+    download: download2,
+    include
   }) {
     this._totalUsage = new import_provider_utils19.DelayedPromise();
     this._finishReason = new import_provider_utils19.DelayedPromise();
@@ -6577,7 +6585,7 @@ var DefaultStreamTextResult = class {
           responseMessages,
           usage
         }) {
-          var _a20, _b, _c, _d, _e, _f;
+          var _a20, _b, _c, _d, _e, _f, _g;
           const includeRawChunks2 = self.includeRawChunks;
           const stepTimeoutId = stepTimeoutMs != null ? setTimeout(() => stepAbortController.abort(), stepTimeoutMs) : void 0;
           let chunkTimeoutId = void 0;
@@ -6707,7 +6715,7 @@ var DefaultStreamTextResult = class {
               experimental_context,
               generateId: generateId2
             });
-            const stepRequest = request != null ? request : {};
+            const stepRequest = ((_g = include == null ? void 0 : include.requestBody) != null ? _g : true) ? request != null ? request : {} : { ...request, body: void 0 };
             const stepToolCalls = [];
             const stepToolOutputs = [];
             let warnings;