@ai-sdk/openai 4.0.0-beta.11 → 4.0.0-beta.12

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 4.0.0-beta.12
+
+### Patch Changes
+
+- d9a1e9a: feat(openai): add server side compaction for openai
+
 ## 4.0.0-beta.11
 
 ### Patch Changes
@@ -47,18 +53,18 @@
   const toolNameMapping = createToolNameMapping({
     tools,
     providerToolNames: {
-      'openai.code_interpreter': 'code_interpreter',
-      'openai.file_search': 'file_search',
-      'openai.image_generation': 'image_generation',
-      'openai.local_shell': 'local_shell',
-      'openai.shell': 'shell',
-      'openai.web_search': 'web_search',
-      'openai.web_search_preview': 'web_search_preview',
-      'openai.mcp': 'mcp',
-      'openai.apply_patch': 'apply_patch',
+      "openai.code_interpreter": "code_interpreter",
+      "openai.file_search": "file_search",
+      "openai.image_generation": "image_generation",
+      "openai.local_shell": "local_shell",
+      "openai.shell": "shell",
+      "openai.web_search": "web_search",
+      "openai.web_search_preview": "web_search_preview",
+      "openai.mcp": "mcp",
+      "openai.apply_patch": "apply_patch",
     },
-    resolveProviderToolName: tool =>
-      tool.id === 'openai.custom'
+    resolveProviderToolName: (tool) =>
+      tool.id === "openai.custom"
         ? (tool.args as { name?: string }).name
         : undefined,
   });
@@ -498,13 +504,13 @@
   Before
 
   ```ts
-  model.textEmbeddingModel('my-model-id');
+  model.textEmbeddingModel("my-model-id");
   ```
 
   After
 
   ```ts
-  model.embeddingModel('my-model-id');
+  model.embeddingModel("my-model-id");
   ```
 
 - 60f4775: fix: remove code for unsuported o1-mini and o1-preview models
@@ -514,15 +520,15 @@
 - 2e86082: feat(provider/openai): `OpenAIChatLanguageModelOptions` type
 
   ```ts
-  import { openai, type OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
-  import { generateText } from 'ai';
+  import { openai, type OpenAIChatLanguageModelOptions } from "@ai-sdk/openai";
+  import { generateText } from "ai";
 
   await generateText({
-    model: openai.chat('gpt-4o'),
-    prompt: 'Invent a new holiday and describe its traditions.',
+    model: openai.chat("gpt-4o"),
+    prompt: "Invent a new holiday and describe its traditions.",
     providerOptions: {
       openai: {
-        user: 'user-123',
+        user: "user-123",
       } satisfies OpenAIChatLanguageModelOptions,
     },
   });
@@ -923,13 +929,13 @@
   Before
 
   ```ts
-  model.textEmbeddingModel('my-model-id');
+  model.textEmbeddingModel("my-model-id");
   ```
 
   After
 
   ```ts
-  model.embeddingModel('my-model-id');
+  model.embeddingModel("my-model-id");
   ```
 
 - Updated dependencies [8d9e8ad]
@@ -1399,15 +1405,15 @@
 - 2e86082: feat(provider/openai): `OpenAIChatLanguageModelOptions` type
 
   ```ts
-  import { openai, type OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
-  import { generateText } from 'ai';
+  import { openai, type OpenAIChatLanguageModelOptions } from "@ai-sdk/openai";
+  import { generateText } from "ai";
 
   await generateText({
-    model: openai.chat('gpt-4o'),
-    prompt: 'Invent a new holiday and describe its traditions.',
+    model: openai.chat("gpt-4o"),
+    prompt: "Invent a new holiday and describe its traditions.",
     providerOptions: {
       openai: {
-        user: 'user-123',
+        user: "user-123",
       } satisfies OpenAIChatLanguageModelOptions,
     },
   });
@@ -1703,7 +1709,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1', {
+    model: luma.image("photon-flash-1", {
       maxImagesPerCall: 5,
       pollIntervalMillis: 500,
     }),
@@ -1716,7 +1722,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1'),
+    model: luma.image("photon-flash-1"),
     prompt,
     n: 10,
     maxImagesPerCall: 5,
@@ -1778,10 +1784,10 @@
   The `experimental_generateImage` method from the `ai` package now returnes revised prompts for OpenAI's image models.
 
   ```js
-  const prompt = 'Santa Claus driving a Cadillac';
+  const prompt = "Santa Claus driving a Cadillac";
 
   const { providerMetadata } = await experimental_generateImage({
-    model: openai.image('dall-e-3'),
+    model: openai.image("dall-e-3"),
     prompt,
   });
 
@@ -2080,7 +2086,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1', {
+    model: luma.image("photon-flash-1", {
       maxImagesPerCall: 5,
       pollIntervalMillis: 500,
     }),
@@ -2093,7 +2099,7 @@
 
   ```js
   await generateImage({
-    model: luma.image('photon-flash-1'),
+    model: luma.image("photon-flash-1"),
     prompt,
     n: 10,
     maxImagesPerCall: 5,
@@ -2138,10 +2144,10 @@
   The `experimental_generateImage` method from the `ai` package now returnes revised prompts for OpenAI's image models.
 
   ```js
-  const prompt = 'Santa Claus driving a Cadillac';
+  const prompt = "Santa Claus driving a Cadillac";
 
   const { providerMetadata } = await experimental_generateImage({
-    model: openai.image('dall-e-3'),
+    model: openai.image("dall-e-3"),
     prompt,
   });
 

package/dist/index.d.mts

@@ -300,6 +300,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content?: string | null | undefined;
     } | {
         type: "shell_call_output";
         id: string;
@@ -483,6 +487,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content: string;
     } | {
         type: "shell_call_output";
         id: string;
@@ -990,6 +998,10 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     user?: string | null | undefined;
     systemMessageMode?: "remove" | "system" | "developer" | undefined;
     forceReasoning?: boolean | undefined;
+    contextManagement?: {
+        type: "compaction";
+        compactThreshold: number;
+    }[] | null | undefined;
 }>;
 type OpenAILanguageModelResponsesOptions = InferSchema<typeof openaiLanguageModelResponsesOptionsSchema>;
 
@@ -1124,6 +1136,14 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesCompactionProviderMetadata = {
+    type: 'compaction';
+    itemId: string;
+    encryptedContent?: string;
+};
+type OpenaiResponsesCompactionProviderMetadata = {
+    openai: ResponsesCompactionProviderMetadata;
+};
 type ResponsesTextProviderMetadata = {
     itemId: string;
     phase?: 'commentary' | 'final_answer' | null;
@@ -1151,4 +1171,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesCompactionProviderMetadata, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };

package/dist/index.d.ts

@@ -300,6 +300,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content?: string | null | undefined;
     } | {
         type: "shell_call_output";
         id: string;
@@ -483,6 +487,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content: string;
     } | {
         type: "shell_call_output";
         id: string;
@@ -990,6 +998,10 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     user?: string | null | undefined;
     systemMessageMode?: "remove" | "system" | "developer" | undefined;
     forceReasoning?: boolean | undefined;
+    contextManagement?: {
+        type: "compaction";
+        compactThreshold: number;
+    }[] | null | undefined;
 }>;
 type OpenAILanguageModelResponsesOptions = InferSchema<typeof openaiLanguageModelResponsesOptionsSchema>;
 
@@ -1124,6 +1136,14 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesCompactionProviderMetadata = {
+    type: 'compaction';
+    itemId: string;
+    encryptedContent?: string;
+};
+type OpenaiResponsesCompactionProviderMetadata = {
+    openai: ResponsesCompactionProviderMetadata;
+};
 type ResponsesTextProviderMetadata = {
     itemId: string;
     phase?: 'commentary' | 'final_answer' | null;
@@ -1151,4 +1171,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesCompactionProviderMetadata, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };

package/dist/index.js

@@ -2656,7 +2656,7 @@ async function convertToOpenAIResponsesInput({
   hasApplyPatchTool = false,
   customProviderToolNames
 }) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r;
   let input = [];
   const warnings = [];
   const processedApprovalIds = /* @__PURE__ */ new Set();
@@ -3003,6 +3003,28 @@ async function convertToOpenAIResponsesInput({
               }
               break;
             }
+            case "custom": {
+              if (part.kind === "openai-compaction") {
+                const providerOpts = (_n = part.providerOptions) == null ? void 0 : _n[providerOptionsName];
+                const id = providerOpts == null ? void 0 : providerOpts.itemId;
+                if (hasConversation && id != null) {
+                  break;
+                }
+                if (store && id != null) {
+                  input.push({ type: "item_reference", id });
+                  break;
+                }
+                const encryptedContent = providerOpts == null ? void 0 : providerOpts.encryptedContent;
+                if (id != null) {
+                  input.push({
+                    type: "compaction",
+                    id,
+                    encrypted_content: encryptedContent
+                  });
+                }
+              }
+              break;
+            }
           }
         }
         break;
@@ -3030,7 +3052,7 @@ async function convertToOpenAIResponsesInput({
           }
           const output = part.output;
           if (output.type === "execution-denied") {
-            const approvalId = (_o = (_n = output.providerOptions) == null ? void 0 : _n.openai) == null ? void 0 : _o.approvalId;
+            const approvalId = (_p = (_o = output.providerOptions) == null ? void 0 : _o.openai) == null ? void 0 : _p.approvalId;
             if (approvalId) {
               continue;
             }
@@ -3104,7 +3126,7 @@ async function convertToOpenAIResponsesInput({
                 outputValue = output.value;
                 break;
               case "execution-denied":
-                outputValue = (_p = output.reason) != null ? _p : "Tool execution denied.";
+                outputValue = (_q = output.reason) != null ? _q : "Tool execution denied.";
                 break;
               case "json":
               case "error-json":
@@ -3158,7 +3180,7 @@ async function convertToOpenAIResponsesInput({
               contentValue = output.value;
               break;
             case "execution-denied":
-              contentValue = (_q = output.reason) != null ? _q : "Tool execution denied.";
+              contentValue = (_r = output.reason) != null ? _r : "Tool execution denied.";
               break;
             case "json":
             case "error-json":
@@ -3410,6 +3432,11 @@ var openaiResponsesChunkSchema = (0, import_provider_utils26.lazySchema)(
               commands: import_v421.z.array(import_v421.z.string())
             })
           }),
+          import_v421.z.object({
+            type: import_v421.z.literal("compaction"),
+            id: import_v421.z.string(),
+            encrypted_content: import_v421.z.string().nullish()
+          }),
           import_v421.z.object({
             type: import_v421.z.literal("shell_call_output"),
             id: import_v421.z.string(),
@@ -3633,6 +3660,11 @@ var openaiResponsesChunkSchema = (0, import_provider_utils26.lazySchema)(
               commands: import_v421.z.array(import_v421.z.string())
             })
           }),
+          import_v421.z.object({
+            type: import_v421.z.literal("compaction"),
+            id: import_v421.z.string(),
+            encrypted_content: import_v421.z.string()
+          }),
           import_v421.z.object({
             type: import_v421.z.literal("shell_call_output"),
             id: import_v421.z.string(),
@@ -4030,6 +4062,11 @@ var openaiResponsesResponseSchema = (0, import_provider_utils26.lazySchema)(
               commands: import_v421.z.array(import_v421.z.string())
             })
           }),
+          import_v421.z.object({
+            type: import_v421.z.literal("compaction"),
+            id: import_v421.z.string(),
+            encrypted_content: import_v421.z.string()
+          }),
           import_v421.z.object({
             type: import_v421.z.literal("shell_call_output"),
             id: import_v421.z.string(),
@@ -4292,7 +4329,16 @@ var openaiLanguageModelResponsesOptionsSchema = (0, import_provider_utils27.lazy
        * When enabled, the SDK applies reasoning-model parameter compatibility rules
        * and defaults `systemMessageMode` to `developer` unless overridden.
        */
-      forceReasoning: import_v422.z.boolean().optional()
+      forceReasoning: import_v422.z.boolean().optional(),
+      /**
+       * Enable server-side context management (compaction).
+       */
+      contextManagement: import_v422.z.array(
+        import_v422.z.object({
+          type: import_v422.z.literal("compaction"),
+          compactThreshold: import_v422.z.number()
+        })
+      ).nullish()
     })
   )
 );
@@ -4759,6 +4805,13 @@ var OpenAIResponsesLanguageModel = class {
       safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
       top_logprobs: topLogprobs,
       truncation: openaiOptions == null ? void 0 : openaiOptions.truncation,
+      // context management (server-side compaction):
+      ...(openaiOptions == null ? void 0 : openaiOptions.contextManagement) && {
+        context_management: openaiOptions.contextManagement.map((cm) => ({
+          type: cm.type,
+          compact_threshold: cm.compactThreshold
+        }))
+      },
       // model-specific settings:
       ...isReasoningModel && ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null) && {
         reasoning: {
@@ -5283,6 +5336,20 @@ var OpenAIResponsesLanguageModel = class {
           });
           break;
         }
+        case "compaction": {
+          content.push({
+            type: "custom",
+            kind: "openai-compaction",
+            providerMetadata: {
+              [providerOptionsName]: {
+                type: "compaction",
+                itemId: part.id,
+                encryptedContent: part.encrypted_content
+              }
+            }
+          });
+          break;
+        }
       }
     }
     const providerMetadata = {
@@ -5912,6 +5979,18 @@ var OpenAIResponsesLanguageModel = class {
                   });
                 }
                 delete activeReasoning[value.item.id];
+              } else if (value.item.type === "compaction") {
+                controller.enqueue({
+                  type: "custom",
+                  kind: "openai-compaction",
+                  providerMetadata: {
+                    [providerOptionsName]: {
+                      type: "compaction",
+                      itemId: value.item.id,
+                      encryptedContent: value.item.encrypted_content
+                    }
+                  }
+                });
               }
             } else if (isResponseFunctionCallArgumentsDeltaChunk(value)) {
               const toolCall = ongoingToolCalls[value.output_index];
@@ -6599,7 +6678,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.0-beta.11" : "0.0.0-test";
+var VERSION = true ? "4.0.0-beta.12" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {