Expose ImageGenerationTool for responses (#702)

Author: ShivangiReja

api/OpenAI.net8.0.cs

@@ -1915,6 +1915,13 @@ model ImageGenTool extends Tool {
     """)
   background?: "transparent" | "opaque" | "auto" = "auto";
 
+  @doc("""
+    Control how much effort the model will exert to match the style and features,
+    especially facial features, of input images. This parameter is only supported
+    for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+    """)
+  input_fidelity?: "low" | "high" = "low";
+
   @doc("""
     Optional mask for inpainting. Contains `image_url`
     (string, optional) and `file_id` (string, optional).
@@ -1937,7 +1944,8 @@ model ImageGenTool extends Tool {
 /** An image generation request made by the model. */
 alias ImageGenToolCallItemBase = {
   /** The generated image encoded in base64. */
-  result: string | null;
+  @encode("base64", string)
+  result: bytes | null;
 };
 
 @@doc(ImageGenToolCallItemResource,
@@ -2285,7 +2293,8 @@ model ResponseImageGenCallPartialImageEvent extends ResponseStreamEvent {
   partial_image_index: int32;
 
   /** Base64-encoded partial image data, suitable for rendering as an image. */
-  partial_image_b64: string;
+  @encode("base64", string)
+  partial_image_b64: bytes;
 }
 
 // Tool customization: Remove shared sequence_number property that was moved to the common parent

api/OpenAI.netstandard2.0.cs

@@ -50,6 +50,9 @@ using Azure.ClientGenerator.Core;
 @@alternateType(MCPListToolsItemResource.error, unknown | null);
 @@clientName(MCPListToolsItemResource.tools, "ToolDefinitions");
 
+@@visibility(ImageGenToolCallItemResource.status, Lifecycle.Read);
+@@clientName(ImageGenToolCallItemResource.result, "GeneratedImageBytes");
+
 // ------------ Tools ------------
 
 @@clientName(FileSearchTool.max_num_results, "MaxResultCount");
@@ -76,4 +79,6 @@ using Azure.ClientGenerator.Core;
 @@alternateType(ResponseMCPCallArgumentsDoneEvent.arguments, unknown);
 // @@clientName(ResponseMCPCallArgumentsDoneEvent.arguments, "ToolArguments");
 
-@@alternateType(ResponseMCPCallArgumentsDeltaEvent.delta, unknown);
+@@alternateType(ResponseMCPCallArgumentsDeltaEvent.delta, unknown);
+
+@@clientName(ResponseImageGenCallPartialImageEvent.partial_image_b64, "PartialImageBytes");

specification/base/typespec/responses/models.tsp

@@ -91,21 +91,12 @@ namespace OpenAI.Responses;
 [CodeGenType("UnknownTool")] internal partial class InternalUnknownTool {}
 [CodeGenType("UnknownToolChoiceObject")] internal partial class InternalUnknownToolChoiceObject {}
 [CodeGenType("WebSearchToolCallItemParam")] internal partial class InternalWebSearchToolCallItemParam {}
-[CodeGenType("ImageGenToolModel")] internal readonly partial struct InternalImageGenToolModel {}
-[CodeGenType("ImageGenToolQuality")] internal readonly partial struct InternalImageGenToolQuality {}
-[CodeGenType("ImageGenToolSize")] internal readonly partial struct InternalImageGenToolSize {}
-[CodeGenType("ImageGenToolOutputFormat")] internal readonly partial struct InternalImageGenToolOutputFormat {}
-[CodeGenType("ImageGenToolModeration")] internal readonly partial struct InternalImageGenToolModeration {}
-[CodeGenType("ImageGenToolBackground")] internal readonly partial struct InternalImageGenToolBackground {}
 [CodeGenType("CodeInterpreterFileOutputType")] internal readonly partial struct InternalCodeInterpreterFileOutputType {}
 [CodeGenType("CodeInterpreterTextOutputType")] internal readonly partial struct InternalCodeInterpreterTextOutputType {}
 [CodeGenType("CodeInterpreterToolOutputType")] internal readonly partial struct InternalCodeInterpreterToolOutputType {}
 [CodeGenType("LocalShellExecActionType")] internal readonly partial struct InternalLocalShellExecActionType {}
-[CodeGenType("ImageGenToolCallItemResourceStatus")] internal readonly partial struct InternalImageGenToolCallItemResourceStatus {}
 [CodeGenType("LocalShellToolCallItemResourceStatus")] internal readonly partial struct InternalLocalShellToolCallItemResourceStatus {}
 [CodeGenType("LocalShellToolCallOutputItemResourceStatus")] internal readonly partial struct InternalLocalShellToolCallOutputItemResourceStatus {}
-[CodeGenType("ImageGenTool")] internal partial class InternalImageGenTool {}
-[CodeGenType("ImageGenToolInputImageMask")] internal partial class InternalImageGenToolInputImageMask {}
 [CodeGenType("LocalShellTool")] internal partial class InternalLocalShellTool {}
 [CodeGenType("MCPToolRequireApproval1")] internal partial class InternalMCPToolRequireApproval1 {}
 [CodeGenType("MCPToolRequireApprovalAlways")] internal partial class InternalMCPToolRequireApprovalAlways {}
@@ -124,13 +115,8 @@ namespace OpenAI.Responses;
 [CodeGenType("MCPApprovalRequestItemParam")] internal partial class InternalMCPApprovalRequestItemParam {}
 [CodeGenType("MCPApprovalResponseItemParam")] internal partial class InternalMCPApprovalResponseItemParam {}
 [CodeGenType("MCPCallItemParam")] internal partial class InternalMCPCallItemParam {}
-[CodeGenType("ImageGenToolCallItemResource")] internal partial class InternalImageGenToolCallItemResource {}
 [CodeGenType("LocalShellToolCallItemResource")] internal partial class InternalLocalShellToolCallItemResource {}
 [CodeGenType("LocalShellToolCallOutputItemResource")] internal partial class InternalLocalShellToolCallOutputItemResource {}
-[CodeGenType("ResponseImageGenCallCompletedEvent")] internal partial class InternalResponseImageGenCallCompletedEvent {}
-[CodeGenType("ResponseImageGenCallGeneratingEvent")] internal partial class InternalResponseImageGenCallGeneratingEvent {}
-[CodeGenType("ResponseImageGenCallInProgressEvent")] internal partial class InternalResponseImageGenCallInProgressEvent {}
-[CodeGenType("ResponseImageGenCallPartialImageEvent")] internal partial class InternalResponseImageGenCallPartialImageEvent {}
 [CodeGenType("ResponseReasoningDeltaEvent")] internal partial class InternalResponseReasoningDeltaEvent {}
 [CodeGenType("ResponseReasoningDoneEvent")] internal partial class InternalResponseReasoningDoneEvent {}
 [CodeGenType("ResponseReasoningSummaryDeltaEvent")] internal partial class InternalResponseReasoningSummaryDeltaEvent {}

specification/client/responses.client.tsp

@@ -0,0 +1,10 @@
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[CodeGenType("ImageGenToolCallItemResource")]
+public partial class ImageGenerationCallResponseItem
+{
+    // CUSTOM: Made nullable since this is a read-only property.
+    [CodeGenMember("Status")]
+    public ImageGenerationCallStatus? Status { get; }
+}

src/Custom/Responses/Internal/GeneratorStubs.cs

@@ -0,0 +1,14 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[Experimental("OPENAI001")]
+[CodeGenType("ImageGenToolCallItemResourceStatus")]
+public enum ImageGenerationCallStatus
+{
+    InProgress,
+    Completed,
+    Generating,
+    Failed
+}

src/Custom/Responses/Items/ImageGenerationTool/ImageGenerationCallResponseItem.cs

@@ -0,0 +1,7 @@
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[CodeGenType("ResponseImageGenCallCompletedEvent")]
+public partial class StreamingResponseImageGenerationCallCompletedUpdate
+{
+}

src/Custom/Responses/Items/ImageGenerationTool/ImageGenerationCallStatus.cs

@@ -0,0 +1,7 @@
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[CodeGenType("ResponseImageGenCallGeneratingEvent")]
+public partial class StreamingResponseImageGenerationCallGeneratingUpdate
+{
+}

src/Custom/Responses/Streaming/StreamingResponseImageGenerationCallCompletedUpdate.cs

@@ -0,0 +1,7 @@
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[CodeGenType("ResponseImageGenCallInProgressEvent")]
+public partial class StreamingResponseImageGenerationCallInProgressUpdate
+{
+}