@ai-sdk/openai 1.3.1 → 1.3.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/openai
 
+## 1.3.3
+
+### Patch Changes
+
+- 24befd8: feat (provider/openai): add instructions to providerOptions
+
+## 1.3.2
+
+### Patch Changes
+
+- db15028: feat (provider/openai): expose type for validating OpenAI responses provider options
+
 ## 1.3.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -294,4 +294,34 @@ Default OpenAI provider instance. It uses 'strict' compatibility mode.
  */
 declare const openai: OpenAIProvider;
 
-export { type OpenAIProvider, type OpenAIProviderSettings, createOpenAI, openai };
+declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    parallelToolCalls: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    previousResponseId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    reasoningEffort?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+    instructions?: string | null | undefined;
+}, {
+    user?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    reasoningEffort?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+    instructions?: string | null | undefined;
+}>;
+type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
+
+export { type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, createOpenAI, openai };

package/dist/index.d.ts

@@ -294,4 +294,34 @@ Default OpenAI provider instance. It uses 'strict' compatibility mode.
  */
 declare const openai: OpenAIProvider;
 
-export { type OpenAIProvider, type OpenAIProviderSettings, createOpenAI, openai };
+declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    parallelToolCalls: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    previousResponseId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    reasoningEffort?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+    instructions?: string | null | undefined;
+}, {
+    user?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    reasoningEffort?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+    instructions?: string | null | undefined;
+}>;
+type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
+
+export { type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, createOpenAI, openai };

package/dist/index.js

@@ -1602,7 +1602,6 @@ 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");
 
@@ -1842,7 +1841,7 @@ var OpenAIResponsesLanguageModel = class {
     providerMetadata,
     responseFormat
   }) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
     const type = mode.type;
@@ -1881,19 +1880,12 @@ var OpenAIResponsesLanguageModel = class {
       systemMessageMode: modelConfig.systemMessageMode
     });
     warnings.push(...messageWarnings);
-    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 openaiOptions = (0, import_provider_utils8.parseProviderOptions)({
+      provider: "openai",
+      providerOptions: providerMetadata,
+      schema: openaiResponsesProviderOptionsSchema
+    });
+    const isStrict = (_a = openaiOptions == null ? void 0 : openaiOptions.strictSchemas) != null ? _a : true;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -1905,7 +1897,7 @@ var OpenAIResponsesLanguageModel = class {
           format: responseFormat.schema != null ? {
             type: "json_schema",
             strict: isStrict,
-            name: (_c = responseFormat.name) != null ? _c : "response",
+            name: (_b = responseFormat.name) != null ? _b : "response",
             description: responseFormat.description,
             schema: responseFormat.schema
           } : { type: "json_object" }
@@ -1917,6 +1909,7 @@ var OpenAIResponsesLanguageModel = class {
       previous_response_id: openaiOptions == null ? void 0 : openaiOptions.previousResponseId,
       store: openaiOptions == null ? void 0 : openaiOptions.store,
       user: openaiOptions == null ? void 0 : openaiOptions.user,
+      instructions: openaiOptions == null ? void 0 : openaiOptions.instructions,
       // model-specific settings:
       ...modelConfig.isReasoningModel && (openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null && {
         reasoning: { effort: openaiOptions == null ? void 0 : openaiOptions.reasoningEffort }
@@ -1967,7 +1960,7 @@ var OpenAIResponsesLanguageModel = class {
               format: mode.schema != null ? {
                 type: "json_schema",
                 strict: isStrict,
-                name: (_d = mode.name) != null ? _d : "response",
+                name: (_c = mode.name) != null ? _c : "response",
                 description: mode.description,
                 schema: mode.schema
               } : { type: "json_object" }
@@ -2360,17 +2353,6 @@ 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")) {
@@ -2392,6 +2374,16 @@ function getResponsesModelConfig(modelId) {
     requiredAutoTruncation: false
   };
 }
+var openaiResponsesProviderOptionsSchema = 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(),
+  instructions: import_zod6.z.string().nullish()
+});
 
 // src/openai-tools.ts
 var import_zod7 = require("zod");