@ai-sdk/openai 4.0.0 → 4.0.2

package/docs/03-openai.mdx

@@ -2503,7 +2503,7 @@ const model = openai.image('dall-e-3');
 
 ### Image Editing
 
-OpenAI's `gpt-image-1` model supports powerful image editing capabilities. Pass input images via `prompt.images` to transform, combine, or edit existing images.
+OpenAI's `gpt-image-*` models support powerful image editing capabilities. Pass input images via `prompt.images` to transform, combine, or edit existing images.
 
 #### Basic Image Editing
 
@@ -2513,7 +2513,7 @@ Transform an existing image using text prompts:
 const imageBuffer = readFileSync('./input-image.png');
 
 const { images } = await generateImage({
-  model: openai.image('gpt-image-1'),
+  model: openai.image('gpt-image-2'),
   prompt: {
     text: 'Turn the cat into a dog but retain the style of the original image',
     images: [imageBuffer],
@@ -2530,7 +2530,7 @@ const image = readFileSync('./input-image.png');
 const mask = readFileSync('./mask.png'); // Transparent areas = edit regions
 
 const { images } = await generateImage({
-  model: openai.image('gpt-image-1'),
+  model: openai.image('gpt-image-2'),
   prompt: {
     text: 'A sunlit indoor lounge area with a pool containing a flamingo',
     images: [image],
@@ -2541,7 +2541,7 @@ const { images } = await generateImage({
 
 #### Background Removal
 
-Remove the background from an image by setting `background` to `transparent`:
+Remove the background from an image by setting `background` to `transparent` on a model that supports transparent backgrounds:
 
 ```ts
 import { openai, type OpenAIImageModelEditOptions } from '@ai-sdk/openai';
@@ -2550,7 +2550,7 @@ import { generateImage } from 'ai';
 const imageBuffer = readFileSync('./input-image.png');
 
 const { images } = await generateImage({
-  model: openai.image('gpt-image-1'),
+  model: openai.image('gpt-image-1.5'),
   prompt: {
     text: 'do not change anything',
     images: [imageBuffer],
@@ -2566,7 +2566,7 @@ const { images } = await generateImage({
 
 #### Multi-Image Combining
 
-Combine multiple reference images into a single output. `gpt-image-1` supports up to 16 input images:
+Combine multiple reference images into a single output. `gpt-image-*` models support up to 16 input images:
 
 ```ts
 const cat = readFileSync('./cat.png');
@@ -2575,7 +2575,7 @@ const owl = readFileSync('./owl.png');
 const bear = readFileSync('./bear.png');
 
 const { images } = await generateImage({
-  model: openai.image('gpt-image-1'),
+  model: openai.image('gpt-image-2'),
   prompt: {
     text: 'Combine these animals into a group photo, retaining the original style',
     images: [cat, dog, owl, bear],
@@ -2585,28 +2585,29 @@ const { images } = await generateImage({
 
 <Note>
   Input images can be provided as `Buffer`, `ArrayBuffer`, `Uint8Array`, or
-  base64-encoded strings. For `gpt-image-1`, each image should be a `png`,
-  `webp`, or `jpg` file less than 50MB.
+  base64-encoded strings. For `gpt-image-*` models, each image should be a
+  `png`, `webp`, or `jpg` file less than 50MB.
 </Note>
 
 ### Model Capabilities
 
 | Model              | Sizes                           |
 | ------------------ | ------------------------------- |
+| `gpt-image-2`      | 1024x1024, 1536x1024, 1024x1536 |
 | `gpt-image-1.5`    | 1024x1024, 1536x1024, 1024x1536 |
 | `gpt-image-1-mini` | 1024x1024, 1536x1024, 1024x1536 |
 | `gpt-image-1`      | 1024x1024, 1536x1024, 1024x1536 |
 | `dall-e-3`         | 1024x1024, 1792x1024, 1024x1792 |
 | `dall-e-2`         | 256x256, 512x512, 1024x1024     |
 
-You can pass optional `providerOptions` to the image model. These are prone to change by OpenAI and are model dependent. For example, the `gpt-image-1` model supports the `quality` option:
+You can pass optional `providerOptions` to the image model. These are prone to change by OpenAI and are model dependent. For example, the `gpt-image-*` models support the `quality` option:
 
 ```ts
 import { openai, type OpenAIImageModelGenerationOptions } from '@ai-sdk/openai';
 import { generateImage } from 'ai';
 
 const { image, providerMetadata } = await generateImage({
-  model: openai.image('gpt-image-1.5'),
+  model: openai.image('gpt-image-2'),
   prompt: 'A salamander at sunrise in a forest pond in the Seychelles.',
   providerOptions: {
     openai: { quality: 'high' } satisfies OpenAIImageModelGenerationOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -35,8 +35,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider-utils": "5.0.0",
-    "@ai-sdk/provider": "4.0.0"
+    "@ai-sdk/provider": "4.0.0",
+    "@ai-sdk/provider-utils": "5.0.1"
   },
   "devDependencies": {
     "@types/node": "22.19.19",

package/src/responses/openai-responses-api.ts

@@ -43,6 +43,7 @@ export type OpenAIResponsesInputItem =
 
 export type OpenAIResponsesIncludeValue =
   | 'web_search_call.action.sources'
+  | 'web_search_call.results'
   | 'code_interpreter_call.outputs'
   | 'computer_call_output.output.image_url'
   | 'file_search_call.results'

package/src/responses/openai-responses-language-model-options.ts

@@ -156,13 +156,14 @@ export const openaiLanguageModelResponsesOptionsSchema = lazySchema(() =>
 
       /**
        * The set of extra fields to include in the response (advanced, usually not needed).
-       * Example values: 'reasoning.encrypted_content', 'file_search_call.results', 'message.output_text.logprobs'.
+       * Example values: 'reasoning.encrypted_content', 'file_search_call.results', 'web_search_call.results', 'message.output_text.logprobs'.
        */
       include: z
         .array(
           z.enum([
             'reasoning.encrypted_content', // handled internally by default, only needed for unknown reasoning models
             'file_search_call.results',
+            'web_search_call.results',
             'message.output_text.logprobs',
           ]),
         )