Add input_fidelity parameter support to image generation tool

Author: seratch

.changeset/shiny-beers-tie.md

@@ -0,0 +1,5 @@
+---
+'@openai/agents-openai': patch
+---
+
+Add input_fidelity parameter support to image generation tool

examples/tools/image-generation.ts

@@ -18,7 +18,7 @@ async function main() {
   const agent = new Agent({
     name: 'Image generator',
     instructions: 'You are a helpful agent.',
-    tools: [imageGenerationTool({ quality: 'low' })],
+    tools: [imageGenerationTool({ quality: 'low', inputFidelity: 'high' })],
   });
 
   await withTrace('Image generation example', async () => {
@@ -40,6 +40,35 @@ async function main() {
         fs.writeFileSync(tmpPath, buffer);
         // console.log(`Image saved to ${tmpPath}`);
         openFile(tmpPath);
+
+        const revisedResult = await run(agent, [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'input_text',
+                text: 'Change only the background of the given image to Japanese style.',
+              },
+              {
+                type: 'input_image',
+                image: 'data:image/png;base64,' + item.rawItem.output,
+              },
+            ],
+          },
+        ]);
+        for (const revisedItem of revisedResult.newItems) {
+          if (
+            revisedItem.type === 'tool_call_item' &&
+            revisedItem.rawItem.type === 'hosted_tool_call' &&
+            revisedItem.rawItem.output
+          ) {
+            const buffer = Buffer.from(revisedItem.rawItem.output, 'base64');
+            const tmpPath = path.join(os.tmpdir(), `image-${Date.now()}.png`);
+            fs.writeFileSync(tmpPath, buffer);
+            // console.log(`Image saved to ${tmpPath}`);
+            openFile(tmpPath);
+          }
+        }
       }
     }
     // or using result.output works too

packages/agents-core/package.json

@@ -90,7 +90,7 @@
   "dependencies": {
     "@openai/zod": "npm:[email protected] - 3.25.67",
     "debug": "^4.4.0",
-    "openai": "^5.0.1"
+    "openai": "^5.10.1"
   },
   "peerDependencies": {
     "zod": "3.25.40 - 3.25.67"

packages/agents-openai/package.json

@@ -19,9 +19,9 @@
   },
   "dependencies": {
     "@openai/agents-core": "workspace:*",
+    "@openai/zod": "npm:[email protected] - 3.25.67",
     "debug": "^4.4.0",
-    "openai": "^5.0.1",
-    "@openai/zod": "npm:[email protected] - 3.25.67"
+    "openai": "^5.10.1"
   },
   "scripts": {
     "prebuild": "tsx ../../scripts/embedMeta.ts",

packages/agents-openai/src/openaiResponsesModel.ts

@@ -174,6 +174,7 @@ function converTool<_TContext = unknown>(
         tool: {
           type: 'image_generation',
           background: tool.providerData.background,
+          input_fidelity: tool.providerData.input_fidelity,
           input_image_mask: tool.providerData.input_image_mask,
           model: tool.providerData.model,
           moderation: tool.providerData.moderation,
@@ -525,7 +526,10 @@ function getInputItems(
           type: 'code_interpreter_call',
           id: item.id!,
           code: item.providerData?.code ?? '',
-          results: item.providerData?.results ?? [],
+          // This property used to be results, so keeping both for backward compatibility
+          // That said, this property cannot be passed from a user, so it's just API's internal data.
+          outputs:
+            item.providerData?.outputs ?? item.providerData?.results ?? [],
           status: CodeInterpreterStatus.parse(item.status ?? 'failed'),
           container_id: item.providerData?.containerId,
         };

packages/agents-openai/src/tools.ts

@@ -156,6 +156,7 @@ export type ImageGenerationTool = {
   type: 'image_generation';
   name?: 'image_generation' | string;
   background?: 'transparent' | 'opaque' | 'auto' | string;
+  inputFidelity?: 'high' | 'low' | null;
   inputImageMask?: OpenAI.Responses.Tool.ImageGeneration.InputImageMask;
   model?: 'gpt-image-1' | string;
   moderation?: 'auto' | 'low' | string;
@@ -178,6 +179,7 @@ export function imageGenerationTool(
     type: 'image_generation',
     name: options.name ?? 'image_generation',
     background: options.background,
+    input_fidelity: options.inputFidelity,
     input_image_mask: options.inputImageMask,
     model: options.model,
     moderation: options.moderation,