@ai-sdk/openai 2.0.0-canary.1 → 2.0.0-canary.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/openai
 
+## 2.0.0-canary.2
+
+### Patch Changes
+
+- Updated dependencies [c57e248]
+- Updated dependencies [33f4a6a]
+  - @ai-sdk/provider@2.0.0-canary.1
+  - @ai-sdk/provider-utils@3.0.0-canary.2
+
 ## 2.0.0-canary.1
 
 ### Patch Changes

package/dist/index.js

@@ -90,7 +90,7 @@ function convertToOpenAIChatMessages({
                   image_url: {
                     url: part.image instanceof URL ? part.image.toString() : `data:${(_a = part.mimeType) != null ? _a : "image/jpeg"};base64,${(0, import_provider_utils.convertUint8ArrayToBase64)(part.image)}`,
                     // OpenAI specific extension: image detail
-                    detail: (_c = (_b = part.providerMetadata) == null ? void 0 : _b.openai) == null ? void 0 : _c.imageDetail
+                    detail: (_c = (_b = part.providerOptions) == null ? void 0 : _b.openai) == null ? void 0 : _c.imageDetail
                   }
                 };
               }
@@ -269,17 +269,16 @@ function getResponseMetadata({
 // src/openai-prepare-tools.ts
 var import_provider2 = require("@ai-sdk/provider");
 function prepareTools({
-  mode,
+  tools,
+  toolChoice,
   useLegacyFunctionCalling = false,
   structuredOutputs
 }) {
-  var _a;
-  const tools = ((_a = mode.tools) == null ? void 0 : _a.length) ? mode.tools : void 0;
+  tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
-    return { tools: void 0, tool_choice: void 0, toolWarnings };
+    return { tools: void 0, toolChoice: void 0, toolWarnings };
   }
-  const toolChoice = mode.toolChoice;
   if (useLegacyFunctionCalling) {
     const openaiFunctions = [];
     for (const tool of tools) {
@@ -339,18 +338,18 @@ function prepareTools({
     }
   }
   if (toolChoice == null) {
-    return { tools: openaiTools2, tool_choice: void 0, toolWarnings };
+    return { tools: openaiTools2, toolChoice: void 0, toolWarnings };
   }
   const type = toolChoice.type;
   switch (type) {
     case "auto":
     case "none":
     case "required":
-      return { tools: openaiTools2, tool_choice: type, toolWarnings };
+      return { tools: openaiTools2, toolChoice: type, toolWarnings };
     case "tool":
       return {
         tools: openaiTools2,
-        tool_choice: {
+        toolChoice: {
           type: "function",
           function: {
             name: toolChoice.toolName
@@ -392,7 +391,6 @@ var OpenAIChatLanguageModel = class {
     return !this.settings.downloadImages;
   }
   getArgs({
-    mode,
     prompt,
     maxTokens,
     temperature,
@@ -403,10 +401,11 @@ var OpenAIChatLanguageModel = class {
     stopSequences,
     responseFormat,
     seed,
-    providerMetadata
+    tools,
+    toolChoice,
+    providerOptions
   }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    const type = mode.type;
+    var _a, _b, _c, _d, _e, _f, _g;
     const warnings = [];
     if (topK != null) {
       warnings.push({
@@ -455,6 +454,7 @@ var OpenAIChatLanguageModel = class {
       top_p: topP,
       frequency_penalty: frequencyPenalty,
       presence_penalty: presencePenalty,
+      // TODO improve below:
       response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? this.supportsStructuredOutputs && responseFormat.schema != null ? {
         type: "json_schema",
         json_schema: {
@@ -468,11 +468,11 @@ var OpenAIChatLanguageModel = class {
       seed,
       // openai specific settings:
       // TODO remove in next major version; we auto-map maxTokens now
-      max_completion_tokens: (_b = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _b.maxCompletionTokens,
-      store: (_c = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _c.store,
-      metadata: (_d = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _d.metadata,
-      prediction: (_e = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _e.prediction,
-      reasoning_effort: (_g = (_f = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _f.reasoningEffort) != null ? _g : this.settings.reasoningEffort,
+      max_completion_tokens: (_b = providerOptions == null ? void 0 : providerOptions.openai) == null ? void 0 : _b.maxCompletionTokens,
+      store: (_c = providerOptions == null ? void 0 : providerOptions.openai) == null ? void 0 : _c.store,
+      metadata: (_d = providerOptions == null ? void 0 : providerOptions.openai) == null ? void 0 : _d.metadata,
+      prediction: (_e = providerOptions == null ? void 0 : providerOptions.openai) == null ? void 0 : _e.prediction,
+      reasoning_effort: (_g = (_f = providerOptions == null ? void 0 : providerOptions.openai) == null ? void 0 : _f.reasoningEffort) != null ? _g : this.settings.reasoningEffort,
       // messages:
       messages
     };
@@ -537,81 +537,28 @@ var OpenAIChatLanguageModel = class {
         baseArgs.max_tokens = void 0;
       }
     }
-    switch (type) {
-      case "regular": {
-        const { tools, tool_choice, functions, function_call, toolWarnings } = prepareTools({
-          mode,
-          useLegacyFunctionCalling,
-          structuredOutputs: this.supportsStructuredOutputs
-        });
-        return {
-          args: {
-            ...baseArgs,
-            tools,
-            tool_choice,
-            functions,
-            function_call
-          },
-          warnings: [...warnings, ...toolWarnings]
-        };
-      }
-      case "object-json": {
-        return {
-          args: {
-            ...baseArgs,
-            response_format: this.supportsStructuredOutputs && mode.schema != null ? {
-              type: "json_schema",
-              json_schema: {
-                schema: mode.schema,
-                strict: true,
-                name: (_h = mode.name) != null ? _h : "response",
-                description: mode.description
-              }
-            } : { type: "json_object" }
-          },
-          warnings
-        };
-      }
-      case "object-tool": {
-        return {
-          args: useLegacyFunctionCalling ? {
-            ...baseArgs,
-            function_call: {
-              name: mode.tool.name
-            },
-            functions: [
-              {
-                name: mode.tool.name,
-                description: mode.tool.description,
-                parameters: mode.tool.parameters
-              }
-            ]
-          } : {
-            ...baseArgs,
-            tool_choice: {
-              type: "function",
-              function: { name: mode.tool.name }
-            },
-            tools: [
-              {
-                type: "function",
-                function: {
-                  name: mode.tool.name,
-                  description: mode.tool.description,
-                  parameters: mode.tool.parameters,
-                  strict: this.supportsStructuredOutputs ? true : void 0
-                }
-              }
-            ]
-          },
-          warnings
-        };
-      }
-      default: {
-        const _exhaustiveCheck = type;
-        throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
-      }
-    }
+    const {
+      tools: openaiTools2,
+      toolChoice: openaiToolChoice,
+      functions,
+      function_call,
+      toolWarnings
+    } = prepareTools({
+      tools,
+      toolChoice,
+      useLegacyFunctionCalling,
+      structuredOutputs: this.supportsStructuredOutputs
+    });
+    return {
+      args: {
+        ...baseArgs,
+        tools: openaiTools2,
+        tool_choice: openaiToolChoice,
+        functions,
+        function_call
+      },
+      warnings: [...warnings, ...toolWarnings]
+    };
   }
   async doGenerate(options) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
@@ -1078,7 +1025,6 @@ var reasoningModels = {
 };
 
 // src/openai-completion-language-model.ts
-var import_provider5 = require("@ai-sdk/provider");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 var import_zod3 = require("zod");
 
@@ -1193,7 +1139,6 @@ var OpenAICompletionLanguageModel = class {
     return this.config.provider;
   }
   getArgs({
-    mode,
     inputFormat,
     prompt,
     maxTokens,
@@ -1204,16 +1149,19 @@ var OpenAICompletionLanguageModel = class {
     presencePenalty,
     stopSequences: userStopSequences,
     responseFormat,
+    tools,
+    toolChoice,
     seed
   }) {
-    var _a;
-    const type = mode.type;
     const warnings = [];
     if (topK != null) {
-      warnings.push({
-        type: "unsupported-setting",
-        setting: "topK"
-      });
+      warnings.push({ type: "unsupported-setting", setting: "topK" });
+    }
+    if (tools == null ? void 0 : tools.length) {
+      warnings.push({ type: "unsupported-setting", setting: "tools" });
+    }
+    if (toolChoice != null) {
+      warnings.push({ type: "unsupported-setting", setting: "toolChoice" });
     }
     if (responseFormat != null && responseFormat.type !== "text") {
       warnings.push({
@@ -1224,56 +1172,30 @@ var OpenAICompletionLanguageModel = class {
     }
     const { prompt: completionPrompt, stopSequences } = convertToOpenAICompletionPrompt({ prompt, inputFormat });
     const stop = [...stopSequences != null ? stopSequences : [], ...userStopSequences != null ? userStopSequences : []];
-    const baseArgs = {
-      // model id:
-      model: this.modelId,
-      // model specific settings:
-      echo: this.settings.echo,
-      logit_bias: this.settings.logitBias,
-      logprobs: typeof this.settings.logprobs === "number" ? this.settings.logprobs : typeof this.settings.logprobs === "boolean" ? this.settings.logprobs ? 0 : void 0 : void 0,
-      suffix: this.settings.suffix,
-      user: this.settings.user,
-      // standardized settings:
-      max_tokens: maxTokens,
-      temperature,
-      top_p: topP,
-      frequency_penalty: frequencyPenalty,
-      presence_penalty: presencePenalty,
-      seed,
-      // prompt:
-      prompt: completionPrompt,
-      // stop sequences:
-      stop: stop.length > 0 ? stop : void 0
+    return {
+      args: {
+        // model id:
+        model: this.modelId,
+        // model specific settings:
+        echo: this.settings.echo,
+        logit_bias: this.settings.logitBias,
+        logprobs: typeof this.settings.logprobs === "number" ? this.settings.logprobs : typeof this.settings.logprobs === "boolean" ? this.settings.logprobs ? 0 : void 0 : void 0,
+        suffix: this.settings.suffix,
+        user: this.settings.user,
+        // standardized settings:
+        max_tokens: maxTokens,
+        temperature,
+        top_p: topP,
+        frequency_penalty: frequencyPenalty,
+        presence_penalty: presencePenalty,
+        seed,
+        // prompt:
+        prompt: completionPrompt,
+        // stop sequences:
+        stop: stop.length > 0 ? stop : void 0
+      },
+      warnings
     };
-    switch (type) {
-      case "regular": {
-        if ((_a = mode.tools) == null ? void 0 : _a.length) {
-          throw new import_provider5.UnsupportedFunctionalityError({
-            functionality: "tools"
-          });
-        }
-        if (mode.toolChoice) {
-          throw new import_provider5.UnsupportedFunctionalityError({
-            functionality: "toolChoice"
-          });
-        }
-        return { args: baseArgs, warnings };
-      }
-      case "object-json": {
-        throw new import_provider5.UnsupportedFunctionalityError({
-          functionality: "object-json mode"
-        });
-      }
-      case "object-tool": {
-        throw new import_provider5.UnsupportedFunctionalityError({
-          functionality: "object-tool mode"
-        });
-      }
-      default: {
-        const _exhaustiveCheck = type;
-        throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
-      }
-    }
   }
   async doGenerate(options) {
     const { args, warnings } = this.getArgs(options);
@@ -1451,7 +1373,7 @@ var openaiCompletionChunkSchema = import_zod3.z.union([
 ]);
 
 // src/openai-embedding-model.ts
-var import_provider6 = require("@ai-sdk/provider");
+var import_provider5 = require("@ai-sdk/provider");
 var import_provider_utils5 = require("@ai-sdk/provider-utils");
 var import_zod4 = require("zod");
 var OpenAIEmbeddingModel = class {
@@ -1478,7 +1400,7 @@ var OpenAIEmbeddingModel = class {
     abortSignal
   }) {
     if (values.length > this.maxEmbeddingsPerCall) {
-      throw new import_provider6.TooManyEmbeddingValuesForCallError({
+      throw new import_provider5.TooManyEmbeddingValuesForCallError({
         provider: this.provider,
         modelId: this.modelId,
         maxEmbeddingsPerCall: this.maxEmbeddingsPerCall,
@@ -1627,7 +1549,7 @@ var import_provider_utils8 = require("@ai-sdk/provider-utils");
 var import_zod7 = require("zod");
 
 // src/responses/convert-to-openai-responses-messages.ts
-var import_provider7 = require("@ai-sdk/provider");
+var import_provider6 = require("@ai-sdk/provider");
 var import_provider_utils7 = require("@ai-sdk/provider-utils");
 function convertToOpenAIResponsesMessages({
   prompt,
@@ -1677,12 +1599,12 @@ function convertToOpenAIResponsesMessages({
                   type: "input_image",
                   image_url: part.image instanceof URL ? part.image.toString() : `data:${(_a = part.mimeType) != null ? _a : "image/jpeg"};base64,${(0, import_provider_utils7.convertUint8ArrayToBase64)(part.image)}`,
                   // OpenAI specific extension: image detail
-                  detail: (_c = (_b = part.providerMetadata) == null ? void 0 : _b.openai) == null ? void 0 : _c.imageDetail
+                  detail: (_c = (_b = part.providerOptions) == null ? void 0 : _b.openai) == null ? void 0 : _c.imageDetail
                 };
               }
               case "file": {
                 if (part.data instanceof URL) {
-                  throw new import_provider7.UnsupportedFunctionalityError({
+                  throw new import_provider6.UnsupportedFunctionalityError({
                     functionality: "File URLs in user messages"
                   });
                 }
@@ -1695,7 +1617,7 @@ function convertToOpenAIResponsesMessages({
                     };
                   }
                   default: {
-                    throw new import_provider7.UnsupportedFunctionalityError({
+                    throw new import_provider6.UnsupportedFunctionalityError({
                       functionality: "Only PDF files are supported in user messages"
                     });
                   }
@@ -1767,18 +1689,17 @@ function mapOpenAIResponseFinishReason({
 }
 
 // src/responses/openai-responses-prepare-tools.ts
-var import_provider8 = require("@ai-sdk/provider");
+var import_provider7 = require("@ai-sdk/provider");
 function prepareResponsesTools({
-  mode,
+  tools,
+  toolChoice,
   strict
 }) {
-  var _a;
-  const tools = ((_a = mode.tools) == null ? void 0 : _a.length) ? mode.tools : void 0;
+  tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
-    return { tools: void 0, tool_choice: void 0, toolWarnings };
+    return { tools: void 0, toolChoice: void 0, toolWarnings };
   }
-  const toolChoice = mode.toolChoice;
   const openaiTools2 = [];
   for (const tool of tools) {
     switch (tool.type) {
@@ -1811,36 +1732,23 @@ function prepareResponsesTools({
     }
   }
   if (toolChoice == null) {
-    return { tools: openaiTools2, tool_choice: void 0, toolWarnings };
+    return { tools: openaiTools2, toolChoice: void 0, toolWarnings };
   }
   const type = toolChoice.type;
   switch (type) {
     case "auto":
     case "none":
     case "required":
-      return { tools: openaiTools2, tool_choice: type, toolWarnings };
-    case "tool": {
-      if (toolChoice.toolName === "web_search_preview") {
-        return {
-          tools: openaiTools2,
-          tool_choice: {
-            type: "web_search_preview"
-          },
-          toolWarnings
-        };
-      }
+      return { tools: openaiTools2, toolChoice: type, toolWarnings };
+    case "tool":
       return {
         tools: openaiTools2,
-        tool_choice: {
-          type: "function",
-          name: toolChoice.toolName
-        },
+        toolChoice: toolChoice.toolName === "web_search_preview" ? { type: "web_search_preview" } : { type: "function", name: toolChoice.toolName },
         toolWarnings
       };
-    }
     default: {
       const _exhaustiveCheck = type;
-      throw new import_provider8.UnsupportedFunctionalityError({
+      throw new import_provider7.UnsupportedFunctionalityError({
         functionality: `Unsupported tool choice type: ${_exhaustiveCheck}`
       });
     }
@@ -1859,7 +1767,6 @@ var OpenAIResponsesLanguageModel = class {
     return this.config.provider;
   }
   getArgs({
-    mode,
     maxTokens,
     temperature,
     stopSequences,
@@ -1869,24 +1776,19 @@ var OpenAIResponsesLanguageModel = class {
     frequencyPenalty,
     seed,
     prompt,
-    providerMetadata,
+    providerOptions,
+    tools,
+    toolChoice,
     responseFormat
   }) {
-    var _a, _b, _c;
+    var _a, _b;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
-    const type = mode.type;
     if (topK != null) {
-      warnings.push({
-        type: "unsupported-setting",
-        setting: "topK"
-      });
+      warnings.push({ type: "unsupported-setting", setting: "topK" });
     }
     if (seed != null) {
-      warnings.push({
-        type: "unsupported-setting",
-        setting: "seed"
-      });
+      warnings.push({ type: "unsupported-setting", setting: "seed" });
     }
     if (presencePenalty != null) {
       warnings.push({
@@ -1901,10 +1803,7 @@ var OpenAIResponsesLanguageModel = class {
       });
     }
     if (stopSequences != null) {
-      warnings.push({
-        type: "unsupported-setting",
-        setting: "stopSequences"
-      });
+      warnings.push({ type: "unsupported-setting", setting: "stopSequences" });
     }
     const { messages, warnings: messageWarnings } = convertToOpenAIResponsesMessages({
       prompt,
@@ -1913,7 +1812,7 @@ var OpenAIResponsesLanguageModel = class {
     warnings.push(...messageWarnings);
     const openaiOptions = (0, import_provider_utils8.parseProviderOptions)({
       provider: "openai",
-      providerOptions: providerMetadata,
+      providerOptions,
       schema: openaiResponsesProviderOptionsSchema
     });
     const isStrict = (_a = openaiOptions == null ? void 0 : openaiOptions.strictSchemas) != null ? _a : true;
@@ -1967,62 +1866,23 @@ var OpenAIResponsesLanguageModel = class {
         });
       }
     }
-    switch (type) {
-      case "regular": {
-        const { tools, tool_choice, toolWarnings } = prepareResponsesTools({
-          mode,
-          strict: isStrict
-          // TODO support provider options on tools
-        });
-        return {
-          args: {
-            ...baseArgs,
-            tools,
-            tool_choice
-          },
-          warnings: [...warnings, ...toolWarnings]
-        };
-      }
-      case "object-json": {
-        return {
-          args: {
-            ...baseArgs,
-            text: {
-              format: mode.schema != null ? {
-                type: "json_schema",
-                strict: isStrict,
-                name: (_c = mode.name) != null ? _c : "response",
-                description: mode.description,
-                schema: mode.schema
-              } : { type: "json_object" }
-            }
-          },
-          warnings
-        };
-      }
-      case "object-tool": {
-        return {
-          args: {
-            ...baseArgs,
-            tool_choice: { type: "function", name: mode.tool.name },
-            tools: [
-              {
-                type: "function",
-                name: mode.tool.name,
-                description: mode.tool.description,
-                parameters: mode.tool.parameters,
-                strict: isStrict
-              }
-            ]
-          },
-          warnings
-        };
-      }
-      default: {
-        const _exhaustiveCheck = type;
-        throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
-      }
-    }
+    const {
+      tools: openaiTools2,
+      toolChoice: openaiToolChoice,
+      toolWarnings
+    } = prepareResponsesTools({
+      tools,
+      toolChoice,
+      strict: isStrict
+    });
+    return {
+      args: {
+        ...baseArgs,
+        tools: openaiTools2,
+        tool_choice: openaiToolChoice
+      },
+      warnings: [...warnings, ...toolWarnings]
+    };
   }
   async doGenerate(options) {
     var _a, _b, _c, _d, _e;