@ai-sdk/openai 4.0.60 → 4.0.62

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @ai-sdk/openai
 
+## 4.0.62
+
+### Patch Changes
+
+- 8487955: Add `xhigh` and `max` quality support for GPT Image 2.5 Flare and Sunburst in image generation, image editing, and the Responses API image generation tool.
+
+## 4.0.61
+
+### Patch Changes
+
+- a4ba394: feat: support per-request models in batch
+- 4a09793: feat(openai): add async tool calling
+- 685ed8c: chore: fix failing CI
+- Updated dependencies [a4ba394]
+- Updated dependencies [45099da]
+- Updated dependencies [9e1d1b2]
+- Updated dependencies [a495511]
+  - @ai-sdk/provider@4.0.11
+  - @ai-sdk/provider-utils@5.0.37
+
 ## 4.0.60
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { JSONValue, ProviderV4, Experimental_BatchLanguageModelV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, Experimental_SpeechTranslationModelV4, SpeechModelV4, Experimental_RealtimeFactoryV4, FilesV4, SkillsV4, Experimental_RealtimeModelV4, Experimental_RealtimeModelV4ClientSecretOptions, Experimental_RealtimeModelV4ClientSecretResult, Experimental_RealtimeModelV4ServerEvent, Experimental_RealtimeModelV4ClientEvent, Experimental_RealtimeModelV4SessionConfig, JSONObject, Experimental_SpeechTranslationModelV4StreamOptions } from '@ai-sdk/provider';
+import { JSONValue, ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, Experimental_SpeechTranslationModelV4, SpeechModelV4, Experimental_RealtimeFactoryV4, FilesV4, SkillsV4, Experimental_BatchV4, Experimental_RealtimeModelV4, Experimental_RealtimeModelV4ClientSecretOptions, Experimental_RealtimeModelV4ClientSecretResult, Experimental_RealtimeModelV4ServerEvent, Experimental_RealtimeModelV4ClientEvent, Experimental_RealtimeModelV4SessionConfig, JSONObject, Experimental_SpeechTranslationModelV4StreamOptions } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema, FetchFunction, WebSocketConstructor, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
@@ -49,7 +49,7 @@ type OpenAIEmbeddingModelOptions = InferSchema<typeof openaiEmbeddingModelOption
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'chatgpt-image-latest' | (string & {});
 declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "low" | "medium" | "high" | "auto" | "standard" | "hd" | undefined;
+    quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
     background?: "auto" | "transparent" | "opaque" | undefined;
     outputFormat?: "png" | "jpeg" | "webp" | undefined;
     outputCompression?: number | undefined;
@@ -57,7 +57,7 @@ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
 }>;
 type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
 declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "low" | "medium" | "high" | "auto" | "standard" | "hd" | undefined;
+    quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
     background?: "auto" | "transparent" | "opaque" | undefined;
     outputFormat?: "png" | "jpeg" | "webp" | undefined;
     outputCompression?: number | undefined;
@@ -67,7 +67,7 @@ declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySche
 }>;
 type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
 declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "low" | "medium" | "high" | "auto" | "standard" | "hd" | undefined;
+    quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
     background?: "auto" | "transparent" | "opaque" | undefined;
     outputFormat?: "png" | "jpeg" | "webp" | undefined;
     outputCompression?: number | undefined;
@@ -443,6 +443,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         call_id: string;
         name: string;
         arguments: string;
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
         caller?: {
             type: "direct";
@@ -519,6 +520,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         call_id: string;
         name: string;
         input: string;
+        async?: boolean | null | undefined;
     } | {
         type: "shell_call";
         id: string;
@@ -695,6 +697,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         arguments: string;
         status: "completed" | "in_progress" | "incomplete";
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
         caller?: {
             type: "direct";
@@ -709,6 +712,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         input: string;
         status: "completed";
+        async?: boolean | null | undefined;
     } | {
         type: "code_interpreter_call";
         id: string;
@@ -949,6 +953,11 @@ declare const customToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFacto
      * An optional description of what the tool does.
      */
     description?: string;
+    /**
+     * Whether the model can continue generating after calling this tool
+     * without waiting for its result.
+     */
+    async?: boolean;
     /**
      * The output format specification for the tool.
      * Omit for unconstrained text output.
@@ -1014,6 +1023,7 @@ declare const openaiTools: {
      * `input` field is a string matching the specified grammar.
      *
      * @param description - An optional description of the tool.
+     * @param async - Whether the model can continue without waiting for the tool result.
      * @param format - The output format constraint (grammar type, syntax, and definition).
      */
     customTool: (args: Parameters<typeof customToolFactory>[0]) => _ai_sdk_provider_utils.ProviderDefinedTool<string, unknown, {}>;
@@ -1124,7 +1134,7 @@ declare const openaiTools: {
      * @param outputCompression - Compression level for the output image (0-100).
      * @param outputFormat - The output format of the generated image. One of 'png', 'jpeg', or 'webp'.
      * @param partialImages - Number of partial images to generate in streaming mode (0-3).
-     * @param quality - The quality of the generated image. One of 'auto', 'low', 'medium', or 'high'.
+     * @param quality - The quality of the generated image. One of 'auto', 'low', 'medium', 'high', 'xhigh', or 'max'. 'xhigh' and 'max' require a GPT Image 2.5 model.
      * @param size - The size of the generated image. One of 'auto', '1024x1024', '1024x1536', or '1536x1024'.
      */
     imageGeneration: (args?: {
@@ -1140,7 +1150,7 @@ declare const openaiTools: {
         outputCompression?: number;
         outputFormat?: "png" | "jpeg" | "webp";
         partialImages?: number;
-        quality?: "auto" | "low" | "medium" | "high";
+        quality?: "auto" | "low" | "medium" | "high" | "xhigh" | "max";
         size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024" | (string & {});
     }) => _ai_sdk_provider_utils.ProviderExecutedTool<{}, {
         result: string;
@@ -1441,11 +1451,11 @@ declare const openAISpeechTranslationModelOptions: _ai_sdk_provider_utils.LazySc
 type OpenAISpeechTranslationModelOptions = InferSchema<typeof openAISpeechTranslationModelOptions>;
 
 interface OpenAIProvider extends ProviderV4 {
-    (modelId: OpenAIResponsesModelId): Experimental_BatchLanguageModelV4;
+    (modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI model for text generation.
      */
-    languageModel(modelId: OpenAIResponsesModelId): Experimental_BatchLanguageModelV4;
+    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI chat model for text generation.
      */
@@ -1453,7 +1463,7 @@ interface OpenAIProvider extends ProviderV4 {
     /**
      * Creates an OpenAI responses API model for text generation.
      */
-    responses(modelId: OpenAIResponsesModelId): Experimental_BatchLanguageModelV4;
+    responses(modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI completion model for text generation.
      */
@@ -1511,6 +1521,12 @@ interface OpenAIProvider extends ProviderV4 {
      * Returns a SkillsV4 interface for uploading skills to OpenAI.
      */
     skills(): SkillsV4;
+    /**
+     * Returns a BatchV4 interface for processing batches with OpenAI.
+     */
+    experimental_batch(): Experimental_BatchV4<{
+        text: OpenAIResponsesModelId;
+    }>;
     /**
      * OpenAI-specific tools.
      */
@@ -1588,6 +1604,11 @@ declare class OpenAIRealtimeModel implements Experimental_RealtimeModelV4 {
 
 type OpenAIToolOptions = {
     allowedCallers?: Array<'direct' | 'programmatic'>;
+    /**
+     * Whether the model can continue generating after calling this tool without
+     * waiting for its result.
+     */
+    async?: boolean;
     deferLoading?: boolean;
     outputSchema?: JSONObject;
     namespace?: {
@@ -1722,6 +1743,20 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesToolCallProviderMetadata = {
+    itemId: string;
+    async?: boolean;
+    namespace?: string;
+    caller?: {
+        type: 'direct';
+    } | {
+        type: 'program';
+        callerId: string;
+    };
+};
+type OpenaiResponsesToolCallProviderMetadata = {
+    openai: ResponsesToolCallProviderMetadata;
+};
 type ResponsesCompactionProviderMetadata = {
     type: 'compaction';
     itemId: string;
@@ -1757,4 +1792,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { OpenAIRealtimeModel as Experimental_OpenAIRealtimeModel, type OpenAIRealtimeModelConfig as Experimental_OpenAIRealtimeModelConfig, OpenAISpeechTranslationModel as Experimental_OpenAISpeechTranslationModel, type OpenAISpeechTranslationModelId as Experimental_OpenAISpeechTranslationModelId, type OpenAISpeechTranslationModelOptions as Experimental_OpenAISpeechTranslationModelOptions, OpenAISpeechTranslationModel as Experimental_OpenAITranslationModel, type OpenAISpeechTranslationModelId as Experimental_OpenAITranslationModelId, type OpenAISpeechTranslationModelOptions as Experimental_OpenAITranslationModelOptions, type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIComputerAction, type OpenAIComputerSafetyCheck, type OpenAIEmbeddingModelOptions, type OpenAIFilesOptions, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAIToolOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesCompactionProviderMetadata, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { OpenAIRealtimeModel as Experimental_OpenAIRealtimeModel, type OpenAIRealtimeModelConfig as Experimental_OpenAIRealtimeModelConfig, OpenAISpeechTranslationModel as Experimental_OpenAISpeechTranslationModel, type OpenAISpeechTranslationModelId as Experimental_OpenAISpeechTranslationModelId, type OpenAISpeechTranslationModelOptions as Experimental_OpenAISpeechTranslationModelOptions, OpenAISpeechTranslationModel as Experimental_OpenAITranslationModel, type OpenAISpeechTranslationModelId as Experimental_OpenAITranslationModelId, type OpenAISpeechTranslationModelOptions as Experimental_OpenAITranslationModelOptions, type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIComputerAction, type OpenAIComputerSafetyCheck, type OpenAIEmbeddingModelOptions, type OpenAIFilesOptions, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAIToolOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesCompactionProviderMetadata, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, VERSION, createOpenAI, openai };