@ai-sdk/openai 3.0.108 → 3.0.110

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 3.0.110
+
+### Patch Changes
+
+- 447ba18: feat(openai): add async tool calling
+- 46c6820: 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.
+
+## 3.0.109
+
+### Patch Changes
+
+- 7f3b8f0: feat(openai): add GPT-6 reasoning configuration updates
+
 ## 3.0.108
 
 ### Patch Changes

package/dist/index.d.mts

@@ -9,7 +9,7 @@ declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<
     logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     user?: string | undefined;
-    reasoningEffort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | "xhigh" | "max" | "none" | "minimal" | undefined;
     maxCompletionTokens?: number | undefined;
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
@@ -48,7 +48,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?: "auto" | "low" | "medium" | "high" | "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;
@@ -56,17 +56,17 @@ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
 }>;
 type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
 declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "auto" | "low" | "medium" | "high" | "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;
     user?: string | undefined;
     style?: "vivid" | "natural" | undefined;
-    moderation?: "auto" | "low" | undefined;
+    moderation?: "low" | "auto" | undefined;
 }>;
 type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
 declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "auto" | "low" | "medium" | "high" | "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;
@@ -341,6 +341,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         call_id: string;
         name: string;
         arguments: string;
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
     } | {
         type: "web_search_call";
@@ -403,6 +404,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;
@@ -471,6 +473,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         arguments: string;
         status: "completed";
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
     } | {
         type: "custom_tool_call";
@@ -479,6 +482,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;
@@ -720,6 +724,11 @@ declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<stri
      * 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.
@@ -786,6 +795,7 @@ declare const openaiTools: {
      *
      * @param name - The name of the custom tool.
      * @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.Tool<string, unknown>;
@@ -853,7 +863,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?: {
@@ -868,7 +878,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";
     }) => _ai_sdk_provider_utils.Tool<{}, {
         result: string;
@@ -986,19 +996,7 @@ declare const openaiTools: {
             type: "approximate";
             country?: string;
             city?: string;
-            region
-            /**
-             * Local shell is a tool that allows agents to run shell commands locally
-             * on a machine you or the user provides.
-             *
-             * Supported models: `gpt-5-codex`
-             */
-            ? /**
-             * Local shell is a tool that allows agents to run shell commands locally
-             * on a machine you or the user provides.
-             *
-             * Supported models: `gpt-5-codex`
-             */: string;
+            region?: string;
             timezone?: string;
         };
     }>;
@@ -1111,6 +1109,7 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     } | undefined;
     promptCacheRetention?: "in_memory" | "24h" | null | undefined;
     reasoningEffort?: string | null | undefined;
+    reasoningEffortUpdate?: "low" | "medium" | "high" | "xhigh" | "max" | undefined;
     reasoningMode?: "standard" | "pro" | undefined;
     reasoningContext?: "auto" | "current_turn" | "all_turns" | undefined;
     reasoningSummary?: string | null | undefined;
@@ -1243,6 +1242,19 @@ declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
  */
 declare const openai: OpenAIProvider;
 
+type OpenAIToolOptions = {
+    /**
+     * Whether the model can continue generating after calling this tool without
+     * waiting for its result.
+     */
+    async?: boolean;
+    deferLoading?: boolean;
+    namespace?: {
+        name: string;
+        description: string;
+    };
+};
+
 type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
 type ResponsesOutputTextAnnotationProviderMetadata = Extract<OpenaiResponsesChunk, {
     type: 'response.output_text.annotation.added';
@@ -1263,6 +1275,14 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesToolCallProviderMetadata = {
+    itemId: string;
+    async?: boolean;
+    namespace?: string;
+};
+type OpenaiResponsesToolCallProviderMetadata = {
+    openai: ResponsesToolCallProviderMetadata;
+};
 type ResponsesTextProviderMetadata = {
     itemId: string;
     phase?: 'commentary' | 'final_answer' | null;
@@ -1290,4 +1310,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, 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 OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, VERSION, createOpenAI, openai };

package/dist/index.d.ts

@@ -9,7 +9,7 @@ declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<
     logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     user?: string | undefined;
-    reasoningEffort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max" | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | "xhigh" | "max" | "none" | "minimal" | undefined;
     maxCompletionTokens?: number | undefined;
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
@@ -48,7 +48,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?: "auto" | "low" | "medium" | "high" | "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;
@@ -56,17 +56,17 @@ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
 }>;
 type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
 declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "auto" | "low" | "medium" | "high" | "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;
     user?: string | undefined;
     style?: "vivid" | "natural" | undefined;
-    moderation?: "auto" | "low" | undefined;
+    moderation?: "low" | "auto" | undefined;
 }>;
 type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
 declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
-    quality?: "auto" | "low" | "medium" | "high" | "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;
@@ -341,6 +341,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         call_id: string;
         name: string;
         arguments: string;
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
     } | {
         type: "web_search_call";
@@ -403,6 +404,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;
@@ -471,6 +473,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         arguments: string;
         status: "completed";
+        async?: boolean | null | undefined;
         namespace?: string | null | undefined;
     } | {
         type: "custom_tool_call";
@@ -479,6 +482,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;
@@ -720,6 +724,11 @@ declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<stri
      * 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.
@@ -786,6 +795,7 @@ declare const openaiTools: {
      *
      * @param name - The name of the custom tool.
      * @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.Tool<string, unknown>;
@@ -853,7 +863,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?: {
@@ -868,7 +878,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";
     }) => _ai_sdk_provider_utils.Tool<{}, {
         result: string;
@@ -986,19 +996,7 @@ declare const openaiTools: {
             type: "approximate";
             country?: string;
             city?: string;
-            region
-            /**
-             * Local shell is a tool that allows agents to run shell commands locally
-             * on a machine you or the user provides.
-             *
-             * Supported models: `gpt-5-codex`
-             */
-            ? /**
-             * Local shell is a tool that allows agents to run shell commands locally
-             * on a machine you or the user provides.
-             *
-             * Supported models: `gpt-5-codex`
-             */: string;
+            region?: string;
             timezone?: string;
         };
     }>;
@@ -1111,6 +1109,7 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     } | undefined;
     promptCacheRetention?: "in_memory" | "24h" | null | undefined;
     reasoningEffort?: string | null | undefined;
+    reasoningEffortUpdate?: "low" | "medium" | "high" | "xhigh" | "max" | undefined;
     reasoningMode?: "standard" | "pro" | undefined;
     reasoningContext?: "auto" | "current_turn" | "all_turns" | undefined;
     reasoningSummary?: string | null | undefined;
@@ -1243,6 +1242,19 @@ declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
  */
 declare const openai: OpenAIProvider;
 
+type OpenAIToolOptions = {
+    /**
+     * Whether the model can continue generating after calling this tool without
+     * waiting for its result.
+     */
+    async?: boolean;
+    deferLoading?: boolean;
+    namespace?: {
+        name: string;
+        description: string;
+    };
+};
+
 type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
 type ResponsesOutputTextAnnotationProviderMetadata = Extract<OpenaiResponsesChunk, {
     type: 'response.output_text.annotation.added';
@@ -1263,6 +1275,14 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesToolCallProviderMetadata = {
+    itemId: string;
+    async?: boolean;
+    namespace?: string;
+};
+type OpenaiResponsesToolCallProviderMetadata = {
+    openai: ResponsesToolCallProviderMetadata;
+};
 type ResponsesTextProviderMetadata = {
     itemId: string;
     phase?: 'commentary' | 'final_answer' | null;
@@ -1290,4 +1310,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, 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 OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, VERSION, createOpenAI, openai };