@ai-sdk/openai 4.0.56 → 4.0.58

package/dist/internal/index.d.ts

@@ -15,7 +15,7 @@ declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
     prediction?: Record<string, any> | undefined;
-    serviceTier?: "default" | "auto" | "flex" | "priority" | "fast" | undefined;
+    serviceTier?: "default" | "auto" | "flex" | "priority" | "fast" | "ultrafast" | undefined;
     strictJsonSchema?: boolean | undefined;
     textVerbosity?: "low" | "medium" | "high" | undefined;
     promptCacheKey?: string | undefined;
@@ -763,6 +763,7 @@ type OpenAIResponsesTool = OpenAIResponsesFunctionTool | {
     filters: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter | undefined;
 } | {
     type: 'image_generation';
+    action: 'generate' | 'edit' | 'auto' | undefined;
     background: 'auto' | 'opaque' | 'transparent' | undefined;
     input_fidelity: 'low' | 'high' | undefined;
     input_image_mask: {
@@ -770,12 +771,12 @@ type OpenAIResponsesTool = OpenAIResponsesFunctionTool | {
         image_url: string | undefined;
     } | undefined;
     model: string | undefined;
-    moderation: 'auto' | undefined;
+    moderation: 'auto' | 'low' | undefined;
     output_compression: number | undefined;
     output_format: 'png' | 'jpeg' | 'webp' | undefined;
     partial_images: number | undefined;
     quality: 'auto' | 'low' | 'medium' | 'high' | undefined;
-    size: 'auto' | '1024x1024' | '1024x1536' | '1536x1024' | undefined;
+    size: 'auto' | '1024x1024' | '1024x1536' | '1536x1024' | (string & {}) | undefined;
 }
 /**
  * Official OpenAI API Specifications: https://platform.openai.com/docs/api-reference/responses/create#responses_create-tools-mcp_tool
@@ -906,20 +907,21 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         incomplete_details?: {
             reason: string;
         } | null | undefined;
-        usage?: {
+        usage?: (Record<string, JSONValue | undefined> & {
             input_tokens: number;
             output_tokens: number;
-            input_tokens_details?: {
+            input_tokens_details?: (Record<string, JSONValue | undefined> & {
                 cached_tokens?: number | null | undefined;
                 cache_write_tokens?: number | null | undefined;
                 orchestration_input_tokens?: number | null | undefined;
                 orchestration_input_cached_tokens?: number | null | undefined;
-            } | null | undefined;
-            output_tokens_details?: {
+            }) | null | undefined;
+            output_tokens_details?: (Record<string, JSONValue | undefined> & {
                 reasoning_tokens?: number | null | undefined;
                 orchestration_output_tokens?: number | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
+            }) | null | undefined;
+            total_tokens?: number | undefined;
+        }) | null | undefined;
         reasoning?: {
             context?: string | null | undefined;
         } | null | undefined;
@@ -936,20 +938,21 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         incomplete_details?: {
             reason: string;
         } | null | undefined;
-        usage?: {
+        usage?: (Record<string, JSONValue | undefined> & {
             input_tokens: number;
             output_tokens: number;
-            input_tokens_details?: {
+            input_tokens_details?: (Record<string, JSONValue | undefined> & {
                 cached_tokens?: number | null | undefined;
                 cache_write_tokens?: number | null | undefined;
                 orchestration_input_tokens?: number | null | undefined;
                 orchestration_input_cached_tokens?: number | null | undefined;
-            } | null | undefined;
-            output_tokens_details?: {
+            }) | null | undefined;
+            output_tokens_details?: (Record<string, JSONValue | undefined> & {
                 reasoning_tokens?: number | null | undefined;
                 orchestration_output_tokens?: number | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
+            }) | null | undefined;
+            total_tokens?: number | undefined;
+        }) | null | undefined;
         reasoning?: {
             context?: string | null | undefined;
         } | null | undefined;
@@ -1868,7 +1871,7 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV4 {
             store: boolean | null | undefined;
             user: string | null | undefined;
             instructions: string | null | undefined;
-            service_tier: "default" | "auto" | "flex" | "priority" | "fast" | null | undefined;
+            service_tier: "default" | "auto" | "flex" | "priority" | "fast" | "ultrafast" | null | undefined;
             include: OpenAIResponsesIncludeOptions;
             prompt_cache_key: string | null | undefined;
             prompt_cache_options: {
@@ -2259,6 +2262,7 @@ declare const fileSearch: _ai_sdk_provider_utils.ProviderExecutedToolFactory<{},
 }, {}>;
 
 declare const imageGenerationArgsSchema: _ai_sdk_provider_utils.LazySchema<{
+    action?: "auto" | "generate" | "edit" | undefined;
     background?: "auto" | "transparent" | "opaque" | undefined;
     inputFidelity?: "low" | "high" | undefined;
     inputImageMask?: {
@@ -2266,17 +2270,21 @@ declare const imageGenerationArgsSchema: _ai_sdk_provider_utils.LazySchema<{
         imageUrl?: string | undefined;
     } | undefined;
     model?: string | undefined;
-    moderation?: "auto" | undefined;
+    moderation?: "auto" | "low" | undefined;
     outputCompression?: number | undefined;
     outputFormat?: "png" | "jpeg" | "webp" | undefined;
     partialImages?: number | undefined;
     quality?: "auto" | "low" | "medium" | "high" | undefined;
-    size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024" | undefined;
+    size?: string | undefined;
 }>;
 declare const imageGenerationOutputSchema: _ai_sdk_provider_utils.LazySchema<{
     result: string;
 }>;
 type ImageGenerationArgs = {
+    /**
+     * Whether to generate a new image or edit an existing image. Default: auto.
+     */
+    action?: 'generate' | 'edit' | 'auto';
     /**
      * Background type for the generated image. Default is 'auto'.
      */
@@ -2304,9 +2312,9 @@ type ImageGenerationArgs = {
      */
     model?: string;
     /**
-     * Moderation level for the generated image. Default: auto.
+     * Moderation level for the generated image. One of auto or low. Default: auto.
      */
-    moderation?: 'auto';
+    moderation?: 'auto' | 'low';
     /**
      * Compression level for the output image. Default: 100.
      */
@@ -2327,10 +2335,11 @@ type ImageGenerationArgs = {
     quality?: 'auto' | 'low' | 'medium' | 'high';
     /**
      * The size of the generated image.
-     * One of 1024x1024, 1024x1536, 1536x1024, or auto.
+     * One of 1024x1024, 1024x1536, 1536x1024, or auto. gpt-image-2 also accepts
+     * arbitrary WIDTHxHEIGHT sizes where both are divisible by 16, e.g. 1536x864.
      * Default: auto.
      */
-    size?: 'auto' | '1024x1024' | '1024x1536' | '1536x1024';
+    size?: 'auto' | '1024x1024' | '1024x1536' | '1536x1024' | (string & {});
 };
 declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_utils.ProviderExecutedTool<{}, {
     /**

package/dist/internal/index.js

@@ -828,11 +828,12 @@ var openaiLanguageModelChatOptions = lazySchema2(
        * - 'flex': 50% cheaper processing at the cost of increased latency. Only available for o3 and o4-mini models.
        * - 'priority': Higher-speed processing with predictably low latency at premium cost. Available for Enterprise customers.
        * - 'fast': OpenAI's newer name for the 'priority' tier. Interchangeable with it.
+       * - 'ultrafast': Access-controlled Ultrafast processing. Only available for gpt-5.6-sol.
        * - 'default': The request will be processed with the standard pricing and performance for the selected model.
        *
        * @default 'auto'
        */
-      serviceTier: z3.enum(["auto", "flex", "priority", "fast", "default"]).optional(),
+      serviceTier: z3.enum(["auto", "flex", "priority", "fast", "ultrafast", "default"]).optional(),
       /**
        * Whether to use strict JSON schema validation.
        *
@@ -4739,6 +4740,31 @@ var jsonValueSchema = z20.lazy(
     z20.record(z20.string(), jsonValueSchema.optional())
   ])
 );
+var jsonObjectSchema = z20.record(z20.string(), jsonValueSchema.optional());
+var openaiResponsesUsageSchema = z20.intersection(
+  jsonObjectSchema,
+  z20.object({
+    input_tokens: z20.number(),
+    input_tokens_details: z20.intersection(
+      jsonObjectSchema,
+      z20.object({
+        cached_tokens: z20.number().nullish(),
+        cache_write_tokens: z20.number().nullish(),
+        orchestration_input_tokens: z20.number().nullish(),
+        orchestration_input_cached_tokens: z20.number().nullish()
+      })
+    ).nullish(),
+    output_tokens: z20.number(),
+    output_tokens_details: z20.intersection(
+      jsonObjectSchema,
+      z20.object({
+        reasoning_tokens: z20.number().nullish(),
+        orchestration_output_tokens: z20.number().nullish()
+      })
+    ).nullish(),
+    total_tokens: z20.number().optional()
+  })
+);
 var openaiResponsesComputerSafetyCheckSchema = z20.object({
   id: z20.string(),
   code: z20.string().nullish(),
@@ -4935,20 +4961,7 @@ var openaiResponsesChunkSchema = lazySchema18(
         type: z20.enum(["response.completed", "response.incomplete"]),
         response: z20.object({
           incomplete_details: z20.object({ reason: z20.string() }).nullish(),
-          usage: z20.object({
-            input_tokens: z20.number(),
-            input_tokens_details: z20.object({
-              cached_tokens: z20.number().nullish(),
-              cache_write_tokens: z20.number().nullish(),
-              orchestration_input_tokens: z20.number().nullish(),
-              orchestration_input_cached_tokens: z20.number().nullish()
-            }).nullish(),
-            output_tokens: z20.number(),
-            output_tokens_details: z20.object({
-              reasoning_tokens: z20.number().nullish(),
-              orchestration_output_tokens: z20.number().nullish()
-            }).nullish()
-          }).nullish(),
+          usage: openaiResponsesUsageSchema.nullish(),
           reasoning: z20.object({
             context: z20.string().nullish()
           }).nullish(),
@@ -4964,20 +4977,7 @@ var openaiResponsesChunkSchema = lazySchema18(
             message: z20.string()
           }).nullish(),
           incomplete_details: z20.object({ reason: z20.string() }).nullish(),
-          usage: z20.object({
-            input_tokens: z20.number(),
-            input_tokens_details: z20.object({
-              cached_tokens: z20.number().nullish(),
-              cache_write_tokens: z20.number().nullish(),
-              orchestration_input_tokens: z20.number().nullish(),
-              orchestration_input_cached_tokens: z20.number().nullish()
-            }).nullish(),
-            output_tokens: z20.number(),
-            output_tokens_details: z20.object({
-              reasoning_tokens: z20.number().nullish(),
-              orchestration_output_tokens: z20.number().nullish()
-            }).nullish()
-          }).nullish(),
+          usage: openaiResponsesUsageSchema.nullish(),
           reasoning: z20.object({
             context: z20.string().nullish()
           }).nullish(),
@@ -5767,20 +5767,7 @@ var openaiResponsesResponseSchema = lazySchema18(
         context: z20.string().nullish()
       }).nullish(),
       incomplete_details: z20.object({ reason: z20.string() }).nullish(),
-      usage: z20.object({
-        input_tokens: z20.number(),
-        input_tokens_details: z20.object({
-          cached_tokens: z20.number().nullish(),
-          cache_write_tokens: z20.number().nullish(),
-          orchestration_input_tokens: z20.number().nullish(),
-          orchestration_input_cached_tokens: z20.number().nullish()
-        }).nullish(),
-        output_tokens: z20.number(),
-        output_tokens_details: z20.object({
-          reasoning_tokens: z20.number().nullish(),
-          orchestration_output_tokens: z20.number().nullish()
-        }).nullish()
-      }).nullish()
+      usage: openaiResponsesUsageSchema.nullish()
     })
   )
 );
@@ -5982,10 +5969,11 @@ var openaiLanguageModelResponsesOptionsSchema = lazySchema19(
        * Set to 'flex' for 50% cheaper processing at the cost of increased latency (available for o3, o4-mini, and gpt-5 models).
        * Set to 'priority' for faster processing with Enterprise access (available for gpt-4, gpt-5, gpt-5-mini, o3, o4-mini; gpt-5-nano is not supported).
        * Set to 'fast' for the same tier as 'priority' (OpenAI's newer name for it).
+       * Set to 'ultrafast' for access-controlled Ultrafast processing (available only for gpt-5.6-sol).
        *
        * Defaults to 'auto'.
        */
-      serviceTier: z21.enum(["auto", "flex", "priority", "fast", "default"]).nullish(),
+      serviceTier: z21.enum(["auto", "flex", "priority", "fast", "ultrafast", "default"]).nullish(),
       /**
        * Whether to store the generation. Defaults to `true`.
        */
@@ -6192,6 +6180,7 @@ import { z as z24 } from "zod/v4";
 var imageGenerationArgsSchema = lazySchema22(
   () => zodSchema22(
     z24.object({
+      action: z24.enum(["generate", "edit", "auto"]).optional(),
       background: z24.enum(["auto", "opaque", "transparent"]).optional(),
       inputFidelity: z24.enum(["low", "high"]).optional(),
       inputImageMask: z24.object({
@@ -6199,12 +6188,15 @@ var imageGenerationArgsSchema = lazySchema22(
         imageUrl: z24.string().optional()
       }).optional(),
       model: z24.string().optional(),
-      moderation: z24.enum(["auto"]).optional(),
+      moderation: z24.enum(["auto", "low"]).optional(),
       outputCompression: z24.number().int().min(0).max(100).optional(),
       outputFormat: z24.enum(["png", "jpeg", "webp"]).optional(),
       partialImages: z24.number().int().min(0).max(3).optional(),
       quality: z24.enum(["auto", "low", "medium", "high"]).optional(),
-      size: z24.enum(["1024x1024", "1024x1536", "1536x1024", "auto"]).optional()
+      size: z24.union([
+        z24.enum(["1024x1024", "1024x1536", "1536x1024", "auto"]),
+        z24.string().regex(/^\d+x\d+$/)
+      ]).optional()
     }).strict()
   )
 );
@@ -6608,6 +6600,7 @@ async function prepareResponsesTools({
             });
             openaiTools.push({
               type: "image_generation",
+              action: args.action,
               background: args.background,
               input_fidelity: args.inputFidelity,
               input_image_mask: args.inputImageMask ? {