@ai-sdk/openai 1.0.14 → 1.0.16

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ai-sdk/openai
 
+## 1.0.16
+
+### Patch Changes
+
+- Updated dependencies [90fb95a]
+- Updated dependencies [e6dfef4]
+- Updated dependencies [6636db6]
+  - @ai-sdk/provider-utils@2.0.7
+
+## 1.0.15
+
+### Patch Changes
+
+- f8c6acb: feat (provider/openai): automatically simulate streaming for reasoning models
+- d0041f7: feat (provider/openai): improved system message support for reasoning models
+- 4d2f97b: feat (provider/openai): improve automatic setting removal for reasoning models
+
 ## 1.0.14
 
 ### Patch Changes

package/dist/index.js

@@ -38,13 +38,32 @@ var import_provider = require("@ai-sdk/provider");
 var import_provider_utils = require("@ai-sdk/provider-utils");
 function convertToOpenAIChatMessages({
   prompt,
-  useLegacyFunctionCalling = false
+  useLegacyFunctionCalling = false,
+  systemMessageMode = "system"
 }) {
   const messages = [];
   for (const { role, content } of prompt) {
     switch (role) {
       case "system": {
-        messages.push({ role: "system", content });
+        switch (systemMessageMode) {
+          case "system": {
+            messages.push({ role: "system", content });
+            break;
+          }
+          case "developer": {
+            messages.push({ role: "developer", content });
+            break;
+          }
+          case "remove": {
+            break;
+          }
+          default: {
+            const _exhaustiveCheck = systemMessageMode;
+            throw new Error(
+              `Unsupported system message mode: ${_exhaustiveCheck}`
+            );
+          }
+        }
         break;
       }
       case "user": {
@@ -403,6 +422,12 @@ var OpenAIChatLanguageModel = class {
         functionality: "structuredOutputs with useLegacyFunctionCalling"
       });
     }
+    if (getSystemMessageMode(this.modelId) === "remove" && prompt.some((message) => message.role === "system")) {
+      warnings.push({
+        type: "other",
+        message: "system messages are removed for this model"
+      });
+    }
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -438,14 +463,64 @@ var OpenAIChatLanguageModel = class {
       // messages:
       messages: convertToOpenAIChatMessages({
         prompt,
-        useLegacyFunctionCalling
+        useLegacyFunctionCalling,
+        systemMessageMode: getSystemMessageMode(this.modelId)
       })
     };
     if (isReasoningModel(this.modelId)) {
-      baseArgs.temperature = void 0;
-      baseArgs.top_p = void 0;
-      baseArgs.frequency_penalty = void 0;
-      baseArgs.presence_penalty = void 0;
+      if (baseArgs.temperature != null) {
+        baseArgs.temperature = void 0;
+        warnings.push({
+          type: "unsupported-setting",
+          setting: "temperature",
+          details: "temperature is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.top_p != null) {
+        baseArgs.top_p = void 0;
+        warnings.push({
+          type: "unsupported-setting",
+          setting: "topP",
+          details: "topP is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.frequency_penalty != null) {
+        baseArgs.frequency_penalty = void 0;
+        warnings.push({
+          type: "unsupported-setting",
+          setting: "frequencyPenalty",
+          details: "frequencyPenalty is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.presence_penalty != null) {
+        baseArgs.presence_penalty = void 0;
+        warnings.push({
+          type: "unsupported-setting",
+          setting: "presencePenalty",
+          details: "presencePenalty is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.logit_bias != null) {
+        baseArgs.logit_bias = void 0;
+        warnings.push({
+          type: "other",
+          message: "logitBias is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.logprobs != null) {
+        baseArgs.logprobs = void 0;
+        warnings.push({
+          type: "other",
+          message: "logprobs is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.top_logprobs != null) {
+        baseArgs.top_logprobs = void 0;
+        warnings.push({
+          type: "other",
+          message: "topLogprobs is not supported for reasoning models"
+        });
+      }
     }
     switch (type) {
       case "regular": {
@@ -590,7 +665,8 @@ var OpenAIChatLanguageModel = class {
     };
   }
   async doStream(options) {
-    if (this.settings.simulateStreaming) {
+    var _a;
+    if ((_a = this.settings.simulateStreaming) != null ? _a : isStreamingSimulatedByDefault(this.modelId)) {
       const result = await this.doGenerate(options);
       const simulatedStream = new ReadableStream({
         start(controller) {
@@ -662,7 +738,7 @@ var OpenAIChatLanguageModel = class {
       stream: response.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
+            var _a2, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -750,7 +826,7 @@ var OpenAIChatLanguageModel = class {
                       message: `Expected 'id' to be a string.`
                     });
                   }
-                  if (((_a = toolCallDelta.function) == null ? void 0 : _a.name) == null) {
+                  if (((_a2 = toolCallDelta.function) == null ? void 0 : _a2.name) == null) {
                     throw new import_provider3.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
@@ -817,13 +893,13 @@ var OpenAIChatLanguageModel = class {
             }
           },
           flush(controller) {
-            var _a, _b;
+            var _a2, _b;
             controller.enqueue({
               type: "finish",
               finishReason,
               logprobs,
               usage: {
-                promptTokens: (_a = usage.promptTokens) != null ? _a : NaN,
+                promptTokens: (_a2 = usage.promptTokens) != null ? _a2 : NaN,
                 completionTokens: (_b = usage.completionTokens) != null ? _b : NaN
               },
               ...providerMetadata != null ? { providerMetadata } : {}
@@ -948,6 +1024,30 @@ function isReasoningModel(modelId) {
 function isAudioModel(modelId) {
   return modelId.startsWith("gpt-4o-audio-preview");
 }
+function getSystemMessageMode(modelId) {
+  var _a, _b;
+  if (!isReasoningModel(modelId)) {
+    return "system";
+  }
+  return (_b = (_a = reasoningModels[modelId]) == null ? void 0 : _a.systemMessageMode) != null ? _b : "developer";
+}
+function isStreamingSimulatedByDefault(modelId) {
+  var _a, _b;
+  if (!isReasoningModel(modelId)) {
+    return false;
+  }
+  return (_b = (_a = reasoningModels[modelId]) == null ? void 0 : _a.simulateStreamingByDefault) != null ? _b : true;
+}
+var reasoningModels = {
+  "o1-mini": {
+    systemMessageMode: "remove",
+    simulateStreamingByDefault: false
+  },
+  "o1-preview": {
+    systemMessageMode: "remove",
+    simulateStreamingByDefault: false
+  }
+};
 
 // src/openai-completion-language-model.ts
 var import_provider5 = require("@ai-sdk/provider");