@ai-sdk/openai 2.0.29 → 2.0.31

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai
 
+## 2.0.31
+
+### Patch Changes
+
+- bb94467: feat(provider/openai): add maxToolCalls provider option
+- 4a2b70e: feat(provider/openai): send item references for provider-executed tool results
+- 643711d: feat (provider/openai): provider defined image generation tool support
+
+## 2.0.30
+
+### Patch Changes
+
+- Updated dependencies [0294b58]
+  - @ai-sdk/provider-utils@3.0.9
+
 ## 2.0.29
 
 ### Patch Changes

package/dist/index.d.mts

@@ -112,6 +112,35 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
+        };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
+    }>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -244,33 +273,34 @@ Default OpenAI provider instance.
 declare const openai: OpenAIProvider;
 
 declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        "file_search_call.results": "file_search_call.results";
+        "message.output_text.logprobs": "message.output_text.logprobs";
+        "reasoning.encrypted_content": "reasoning.encrypted_content";
+    }>>>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    maxToolCalls: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     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>>;
+    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     serviceTier: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         auto: "auto";
         flex: "flex";
         priority: "priority";
     }>>>;
-    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
-        "file_search_call.results": "file_search_call.results";
-        "message.output_text.logprobs": "message.output_text.logprobs";
-        "reasoning.encrypted_content": "reasoning.encrypted_content";
-    }>>>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     textVerbosity: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         low: "low";
         medium: "medium";
         high: "high";
     }>>>;
-    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 

package/dist/index.d.ts

@@ -112,6 +112,35 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * The image generation tool allows you to generate images using a text prompt,
+     * and optionally image inputs. It leverages the GPT Image model,
+     * and automatically optimizes text inputs for improved performance.
+     *
+     * Must have name `image_generation`.
+     *
+     * @param size - Image dimensions (e.g., 1024x1024, 1024x1536)
+     * @param quality - Rendering quality (e.g. low, medium, high)
+     * @param format - File output format
+     * @param compression - Compression level (0-100%) for JPEG and WebP formats
+     * @param background - Transparent or opaque
+     */
+    imageGeneration: (args?: {
+        background?: "auto" | "opaque" | "transparent";
+        inputFidelity?: "low" | "high";
+        inputImageMask?: {
+            fileId?: string;
+            imageUrl?: string;
+        };
+        model?: string;
+        moderation?: "auto";
+        outputCompression?: number;
+        outputFormat?: "png" | "jpeg" | "webp";
+        quality?: "auto" | "low" | "medium" | "high";
+        size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
+    }) => _ai_sdk_provider_utils.Tool<{}, {
+        result: string;
+    }>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -244,33 +273,34 @@ Default OpenAI provider instance.
 declare const openai: OpenAIProvider;
 
 declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        "file_search_call.results": "file_search_call.results";
+        "message.output_text.logprobs": "message.output_text.logprobs";
+        "reasoning.encrypted_content": "reasoning.encrypted_content";
+    }>>>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    maxToolCalls: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     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>>;
+    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     serviceTier: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         auto: "auto";
         flex: "flex";
         priority: "priority";
     }>>>;
-    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
-        "file_search_call.results": "file_search_call.results";
-        "message.output_text.logprobs": "message.output_text.logprobs";
-        "reasoning.encrypted_content": "reasoning.encrypted_content";
-    }>>>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    strictJsonSchema: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     textVerbosity: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         low: "low";
         medium: "medium";
         high: "high";
     }>>>;
-    promptCacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    safetyIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    logprobs: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodNumber]>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;