@ai-sdk/openai 3.0.60 → 3.0.62

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/openai
 
+## 3.0.62
+
+### Patch Changes
+
+- 65edcca: feat: add allowedTools provider option for OpenAI Responses
+
+## 3.0.61
+
+### Patch Changes
+
+- b93f9b4: feat(provider/openai): forward imageDetail providerOptions on tool-result image content
+
 ## 3.0.60
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1058,6 +1058,10 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     user?: string | null | undefined;
     systemMessageMode?: "remove" | "system" | "developer" | undefined;
     forceReasoning?: boolean | undefined;
+    allowedTools?: {
+        toolNames: string[];
+        mode?: "auto" | "required" | undefined;
+    } | undefined;
 }>;
 type OpenAILanguageModelResponsesOptions = InferSchema<typeof openaiLanguageModelResponsesOptionsSchema>;
 

package/dist/index.d.ts

@@ -1058,6 +1058,10 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     user?: string | null | undefined;
     systemMessageMode?: "remove" | "system" | "developer" | undefined;
     forceReasoning?: boolean | undefined;
+    allowedTools?: {
+        toolNames: string[];
+        mode?: "auto" | "required" | undefined;
+    } | undefined;
 }>;
 type OpenAILanguageModelResponsesOptions = InferSchema<typeof openaiLanguageModelResponsesOptionsSchema>;
 

package/dist/index.js

@@ -3204,24 +3204,26 @@ async function convertToOpenAIResponsesInput({
                 break;
               case "content":
                 outputValue = output.value.map((item) => {
-                  var _a2;
+                  var _a2, _b2, _c2, _d2, _e2;
                   switch (item.type) {
                     case "text":
                       return { type: "input_text", text: item.text };
                     case "image-data":
                       return {
                         type: "input_image",
-                        image_url: `data:${item.mediaType};base64,${item.data}`
+                        image_url: `data:${item.mediaType};base64,${item.data}`,
+                        detail: (_b2 = (_a2 = item.providerOptions) == null ? void 0 : _a2[providerOptionsName]) == null ? void 0 : _b2.imageDetail
                       };
                     case "image-url":
                       return {
                         type: "input_image",
-                        image_url: item.url
+                        image_url: item.url,
+                        detail: (_d2 = (_c2 = item.providerOptions) == null ? void 0 : _c2[providerOptionsName]) == null ? void 0 : _d2.imageDetail
                       };
                     case "file-data":
                       return {
                         type: "input_file",
-                        filename: (_a2 = item.filename) != null ? _a2 : "data",
+                        filename: (_e2 = item.filename) != null ? _e2 : "data",
                         file_data: `data:${item.mediaType};base64,${item.data}`
                       };
                     case "file-url":
@@ -3263,7 +3265,7 @@ async function convertToOpenAIResponsesInput({
               break;
             case "content":
               contentValue = output.value.map((item) => {
-                var _a2;
+                var _a2, _b2, _c2, _d2, _e2;
                 switch (item.type) {
                   case "text": {
                     return { type: "input_text", text: item.text };
@@ -3271,19 +3273,21 @@ async function convertToOpenAIResponsesInput({
                   case "image-data": {
                     return {
                       type: "input_image",
-                      image_url: `data:${item.mediaType};base64,${item.data}`
+                      image_url: `data:${item.mediaType};base64,${item.data}`,
+                      detail: (_b2 = (_a2 = item.providerOptions) == null ? void 0 : _a2[providerOptionsName]) == null ? void 0 : _b2.imageDetail
                     };
                   }
                   case "image-url": {
                     return {
                       type: "input_image",
-                      image_url: item.url
+                      image_url: item.url,
+                      detail: (_d2 = (_c2 = item.providerOptions) == null ? void 0 : _c2[providerOptionsName]) == null ? void 0 : _d2.imageDetail
                     };
                   }
                   case "file-data": {
                     return {
                       type: "input_file",
-                      filename: (_a2 = item.filename) != null ? _a2 : "data",
+                      filename: (_e2 = item.filename) != null ? _e2 : "data",
                       file_data: `data:${item.mediaType};base64,${item.data}`
                     };
                   }
@@ -4421,7 +4425,21 @@ var openaiLanguageModelResponsesOptionsSchema = (0, import_provider_utils28.lazy
        * When enabled, the SDK applies reasoning-model parameter compatibility rules
        * and defaults `systemMessageMode` to `developer` unless overridden.
        */
-      forceReasoning: import_v423.z.boolean().optional()
+      forceReasoning: import_v423.z.boolean().optional(),
+      /**
+       * Restrict the callable tools to a subset while keeping the full tools
+       * list intact, so prompt caching is preserved across requests with
+       * different allowlists.
+       *
+       * When set, this overrides the request-level `toolChoice` and emits
+       * `tool_choice: { type: "allowed_tools", mode, tools }` on the wire.
+       *
+       * @see https://developers.openai.com/api/reference/resources/responses/methods/create#(resource)%20responses%20%3E%20(model)%20tool_choice_allowed%20%3E%20(schema)
+       */
+      allowedTools: import_v423.z.object({
+        toolNames: import_v423.z.array(import_v423.z.string()).min(1),
+        mode: import_v423.z.enum(["auto", "required"]).optional()
+      }).optional()
     })
   )
 );
@@ -4432,10 +4450,11 @@ var import_provider_utils29 = require("@ai-sdk/provider-utils");
 async function prepareResponsesTools({
   tools,
   toolChoice,
+  allowedTools,
   toolNameMapping,
   customProviderToolNames
 }) {
-  var _a, _b;
+  var _a, _b, _c;
   tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
@@ -4626,6 +4645,23 @@ async function prepareResponsesTools({
         break;
     }
   }
+  if (allowedTools != null) {
+    return {
+      tools: openaiTools2,
+      toolChoice: {
+        type: "allowed_tools",
+        mode: (_b = allowedTools.mode) != null ? _b : "auto",
+        tools: allowedTools.toolNames.map((name) => {
+          var _a2;
+          return {
+            type: "function",
+            name: (_a2 = toolNameMapping == null ? void 0 : toolNameMapping.toProviderToolName(name)) != null ? _a2 : name
+          };
+        })
+      },
+      toolWarnings
+    };
+  }
   if (toolChoice == null) {
     return { tools: openaiTools2, toolChoice: void 0, toolWarnings };
   }
@@ -4636,7 +4672,7 @@ async function prepareResponsesTools({
     case "required":
       return { tools: openaiTools2, toolChoice: type, toolWarnings };
     case "tool": {
-      const resolvedToolName = (_b = toolNameMapping == null ? void 0 : toolNameMapping.toProviderToolName(toolChoice.toolName)) != null ? _b : toolChoice.toolName;
+      const resolvedToolName = (_c = toolNameMapping == null ? void 0 : toolNameMapping.toProviderToolName(toolChoice.toolName)) != null ? _c : toolChoice.toolName;
       return {
         tools: openaiTools2,
         toolChoice: resolvedToolName === "code_interpreter" || resolvedToolName === "file_search" || resolvedToolName === "image_generation" || resolvedToolName === "web_search_preview" || resolvedToolName === "web_search" || resolvedToolName === "mcp" || resolvedToolName === "apply_patch" ? { type: resolvedToolName } : resolvedCustomProviderToolNames.has(resolvedToolName) ? { type: "custom", name: resolvedToolName } : { type: "function", name: resolvedToolName },
@@ -4742,7 +4778,7 @@ var OpenAIResponsesLanguageModel = class {
     toolChoice,
     responseFormat
   }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
     const warnings = [];
     const modelCapabilities = getOpenAILanguageModelCapabilities(this.modelId);
     if (topK != null) {
@@ -4805,16 +4841,17 @@ var OpenAIResponsesLanguageModel = class {
     } = await prepareResponsesTools({
       tools,
       toolChoice,
+      allowedTools: (_b = openaiOptions == null ? void 0 : openaiOptions.allowedTools) != null ? _b : void 0,
       toolNameMapping,
       customProviderToolNames
     });
     const { input, warnings: inputWarnings } = await convertToOpenAIResponsesInput({
       prompt,
       toolNameMapping,
-      systemMessageMode: (_b = openaiOptions == null ? void 0 : openaiOptions.systemMessageMode) != null ? _b : isReasoningModel ? "developer" : modelCapabilities.systemMessageMode,
+      systemMessageMode: (_c = openaiOptions == null ? void 0 : openaiOptions.systemMessageMode) != null ? _c : isReasoningModel ? "developer" : modelCapabilities.systemMessageMode,
       providerOptionsName,
       fileIdPrefixes: this.config.fileIdPrefixes,
-      store: (_c = openaiOptions == null ? void 0 : openaiOptions.store) != null ? _c : true,
+      store: (_d = openaiOptions == null ? void 0 : openaiOptions.store) != null ? _d : true,
       hasConversation: (openaiOptions == null ? void 0 : openaiOptions.conversation) != null,
       hasLocalShellTool: hasOpenAITool("openai.local_shell"),
       hasShellTool: hasOpenAITool("openai.shell"),
@@ -4822,7 +4859,7 @@ var OpenAIResponsesLanguageModel = class {
       customProviderToolNames: customProviderToolNames.size > 0 ? customProviderToolNames : void 0
     });
     warnings.push(...inputWarnings);
-    const strictJsonSchema = (_d = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _d : true;
+    const strictJsonSchema = (_e = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _e : true;
     let include = openaiOptions == null ? void 0 : openaiOptions.include;
     function addInclude(key) {
       if (include == null) {
@@ -4838,9 +4875,9 @@ var OpenAIResponsesLanguageModel = class {
     if (topLogprobs) {
       addInclude("message.output_text.logprobs");
     }
-    const webSearchToolName = (_e = tools == null ? void 0 : tools.find(
+    const webSearchToolName = (_f = tools == null ? void 0 : tools.find(
       (tool) => tool.type === "provider" && (tool.id === "openai.web_search" || tool.id === "openai.web_search_preview")
-    )) == null ? void 0 : _e.name;
+    )) == null ? void 0 : _f.name;
     if (webSearchToolName) {
       addInclude("web_search_call.action.sources");
     }
@@ -4863,7 +4900,7 @@ var OpenAIResponsesLanguageModel = class {
             format: responseFormat.schema != null ? {
               type: "json_schema",
               strict: strictJsonSchema,
-              name: (_f = responseFormat.name) != null ? _f : "response",
+              name: (_g = responseFormat.name) != null ? _g : "response",
               description: responseFormat.description,
               schema: responseFormat.schema
             } : { type: "json_object" }
@@ -4952,9 +4989,9 @@ var OpenAIResponsesLanguageModel = class {
       });
       delete baseArgs.service_tier;
     }
-    const shellToolEnvType = (_i = (_h = (_g = tools == null ? void 0 : tools.find(
+    const shellToolEnvType = (_j = (_i = (_h = tools == null ? void 0 : tools.find(
       (tool) => tool.type === "provider" && tool.id === "openai.shell"
-    )) == null ? void 0 : _g.args) == null ? void 0 : _h.environment) == null ? void 0 : _i.type;
+    )) == null ? void 0 : _h.args) == null ? void 0 : _i.environment) == null ? void 0 : _j.type;
     const isShellProviderExecuted = shellToolEnvType === "containerAuto" || shellToolEnvType === "containerReference";
     return {
       webSearchToolName,
@@ -6753,7 +6790,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.60" : "0.0.0-test";
+var VERSION = true ? "3.0.62" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {