@ai-sdk/openai 1.2.3 → 1.2.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 1.2.4
+
+### Patch Changes
+
+- 523f128: feat (provider/openai): add strictSchemas option to responses model
+
 ## 1.2.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -71,6 +71,8 @@ interface OpenAIChatSettings {
   Enable this if the model that you are using does not support streaming.
   
   Defaults to `false`.
+  
+  @deprecated Use `simulateStreamingMiddleware` instead.
      */
     simulateStreaming?: boolean;
     /**

package/dist/index.d.ts

@@ -71,6 +71,8 @@ interface OpenAIChatSettings {
   Enable this if the model that you are using does not support streaming.
   
   Defaults to `false`.
+  
+  @deprecated Use `simulateStreamingMiddleware` instead.
      */
     simulateStreaming?: boolean;
     /**

package/dist/index.js

@@ -1601,6 +1601,7 @@ var openaiImageResponseSchema = import_zod5.z.object({
 });
 
 // src/responses/openai-responses-language-model.ts
+var import_provider9 = require("@ai-sdk/provider");
 var import_provider_utils8 = require("@ai-sdk/provider-utils");
 var import_zod6 = require("zod");
 
@@ -1824,7 +1825,7 @@ var OpenAIResponsesLanguageModel = class {
     providerMetadata,
     responseFormat
   }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
+    var _a, _b, _c, _d;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
     const type = mode.type;
@@ -1863,7 +1864,19 @@ var OpenAIResponsesLanguageModel = class {
       systemMessageMode: modelConfig.systemMessageMode
     });
     warnings.push(...messageWarnings);
-    const isStrictJsonSchema = (_b = (_a = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _a.strictJsonSchema) != null ? _b : true;
+    const parsedProviderOptions = providerMetadata != null ? (0, import_provider_utils8.safeValidateTypes)({
+      value: providerMetadata,
+      schema: providerOptionsSchema
+    }) : { success: true, value: void 0 };
+    if (!parsedProviderOptions.success) {
+      throw new import_provider9.InvalidArgumentError({
+        argument: "providerOptions",
+        message: "invalid provider options",
+        cause: parsedProviderOptions.error
+      });
+    }
+    const openaiOptions = (_a = parsedProviderOptions.value) == null ? void 0 : _a.openai;
+    const isStrict = (_b = openaiOptions == null ? void 0 : openaiOptions.strictSchemas) != null ? _b : true;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -1874,7 +1887,7 @@ var OpenAIResponsesLanguageModel = class {
         text: {
           format: responseFormat.schema != null ? {
             type: "json_schema",
-            strict: isStrictJsonSchema,
+            strict: isStrict,
             name: (_c = responseFormat.name) != null ? _c : "response",
             description: responseFormat.description,
             schema: responseFormat.schema
@@ -1882,14 +1895,14 @@ var OpenAIResponsesLanguageModel = class {
         }
       },
       // provider options:
-      metadata: (_d = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _d.metadata,
-      parallel_tool_calls: (_e = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _e.parallelToolCalls,
-      previous_response_id: (_f = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _f.previousResponseId,
-      store: (_g = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _g.store,
-      user: (_h = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _h.user,
+      metadata: openaiOptions == null ? void 0 : openaiOptions.metadata,
+      parallel_tool_calls: openaiOptions == null ? void 0 : openaiOptions.parallelToolCalls,
+      previous_response_id: openaiOptions == null ? void 0 : openaiOptions.previousResponseId,
+      store: openaiOptions == null ? void 0 : openaiOptions.store,
+      user: openaiOptions == null ? void 0 : openaiOptions.user,
       // model-specific settings:
-      ...modelConfig.isReasoningModel && ((_i = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _i.reasoningEffort) != null && {
-        reasoning: { effort: (_j = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _j.reasoningEffort }
+      ...modelConfig.isReasoningModel && (openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null && {
+        reasoning: { effort: openaiOptions == null ? void 0 : openaiOptions.reasoningEffort }
       },
       ...modelConfig.requiredAutoTruncation && {
         truncation: "auto"
@@ -1917,7 +1930,8 @@ var OpenAIResponsesLanguageModel = class {
       case "regular": {
         const { tools, tool_choice, toolWarnings } = prepareResponsesTools({
           mode,
-          strict: true
+          strict: isStrict
+          // TODO support provider options on tools
         });
         return {
           args: {
@@ -1935,8 +1949,8 @@ var OpenAIResponsesLanguageModel = class {
             text: {
               format: mode.schema != null ? {
                 type: "json_schema",
-                strict: isStrictJsonSchema,
-                name: (_k = mode.name) != null ? _k : "response",
+                strict: isStrict,
+                name: (_d = mode.name) != null ? _d : "response",
                 description: mode.description,
                 schema: mode.schema
               } : { type: "json_object" }
@@ -1956,7 +1970,7 @@ var OpenAIResponsesLanguageModel = class {
                 name: mode.tool.name,
                 description: mode.tool.description,
                 parameters: mode.tool.parameters,
-                strict: isStrictJsonSchema
+                strict: isStrict
               }
             ]
           },
@@ -2329,6 +2343,17 @@ function isResponseOutputItemAddedChunk(chunk) {
 function isResponseAnnotationAddedChunk(chunk) {
   return chunk.type === "response.output_text.annotation.added";
 }
+var providerOptionsSchema = import_zod6.z.object({
+  openai: import_zod6.z.object({
+    metadata: import_zod6.z.any().nullish(),
+    parallelToolCalls: import_zod6.z.boolean().nullish(),
+    previousResponseId: import_zod6.z.string().nullish(),
+    store: import_zod6.z.boolean().nullish(),
+    user: import_zod6.z.string().nullish(),
+    reasoningEffort: import_zod6.z.string().nullish(),
+    strictSchemas: import_zod6.z.boolean().nullish()
+  }).nullish()
+});
 function getResponsesModelConfig(modelId) {
   if (modelId.startsWith("o")) {
     if (modelId.startsWith("o1-mini") || modelId.startsWith("o1-preview")) {