Skip to content

Expose ImageGenerationTool for responses #702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 24, 2025
Merged

Expose ImageGenerationTool for responses #702

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc598e8
Expose ImageGenerationTool for responses
ShivangiReja Sep 22, 2025
971cf2e
Merge branch 'main' of https://github.com/openai/openai-dotnet into s…
ShivangiReja Sep 23, 2025
3f439aa
Feedback
ShivangiReja Sep 23, 2025
8ded201
Merge branch 'main' of https://github.com/openai/openai-dotnet into s…
ShivangiReja Sep 23, 2025
e4edc8e
Update ImageGenerationToolInputImageMask
ShivangiReja Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 56 additions & 37 deletions api/OpenAI.net8.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4980,9 +4980,9 @@ public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistable
}
[Experimental("OPENAI001")]
public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
public ImageGenerationCallResponseItem(ImageGenerationCallStatus status, string result);
public string Result { get; set; }
public ImageGenerationCallStatus Status { get; set; }
public ImageGenerationCallResponseItem(BinaryData generatedImageBytes);
public BinaryData GeneratedImageBytes { get; set; }
public ImageGenerationCallStatus? Status { get; }
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
Expand All @@ -4999,12 +4999,13 @@ public enum ImageGenerationCallStatus {
public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
public ImageGenerationTool();
public ImageGenerationToolBackground? Background { get; set; }
public ImageGenerationToolInputFidelityLevel? InputFidelityLevel { get; set; }
public ImageGenerationToolInputImageMask InputImageMask { get; set; }
public string Model { get; set; }
public ImageGenerationToolModeration? Moderation { get; set; }
public int? OutputCompression { get; set; }
public ImageGenerationToolOutputFormat? OutputFormat { get; set; }
public int? PartialImages { get; set; }
public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
public int? OutputCompressionFactor { get; set; }
public ImageGenerationToolOutputFileFormat? OutputFileFormat { get; set; }
public int? PartialImageCount { get; set; }
public ImageGenerationToolQuality? Quality { get; set; }
public ImageGenerationToolSize? Size { get; set; }
protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
Expand All @@ -5030,45 +5031,64 @@ public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>
public override readonly string ToString();
}
[Experimental("OPENAI001")]
public readonly partial struct ImageGenerationToolInputFidelityLevel : IEquatable<ImageGenerationToolInputFidelityLevel> {
public ImageGenerationToolInputFidelityLevel(string value);
public static ImageGenerationToolInputFidelityLevel High { get; }
public static ImageGenerationToolInputFidelityLevel Low { get; }
public readonly bool Equals(ImageGenerationToolInputFidelityLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
public static implicit operator ImageGenerationToolInputFidelityLevel(string value);
public static implicit operator ImageGenerationToolInputFidelityLevel?(string value);
public static bool operator !=(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
public override readonly string ToString();
}
[Experimental("OPENAI001")]
public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolInputImageMask>, IPersistableModel<ImageGenerationToolInputImageMask> {
public string FileId { get; set; }
public string ImageUrl { get; set; }
public ImageGenerationToolInputImageMask(BinaryData imageBytes, string imageBytesMediaType);
public ImageGenerationToolInputImageMask(string fileId);
public ImageGenerationToolInputImageMask(Uri imageUri);
public string FileId { get; }
public string ImageUrl { get; }
protected virtual ImageGenerationToolInputImageMask JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
protected virtual ImageGenerationToolInputImageMask PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
}
[Experimental("OPENAI001")]
public readonly partial struct ImageGenerationToolModeration : IEquatable<ImageGenerationToolModeration> {
public ImageGenerationToolModeration(string value);
public static ImageGenerationToolModeration Auto { get; }
public static ImageGenerationToolModeration Low { get; }
public readonly bool Equals(ImageGenerationToolModeration other);
public readonly partial struct ImageGenerationToolModerationLevel : IEquatable<ImageGenerationToolModerationLevel> {
public ImageGenerationToolModerationLevel(string value);
public static ImageGenerationToolModerationLevel Auto { get; }
public static ImageGenerationToolModerationLevel Low { get; }
public readonly bool Equals(ImageGenerationToolModerationLevel other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolModeration left, ImageGenerationToolModeration right);
public static implicit operator ImageGenerationToolModeration(string value);
public static implicit operator ImageGenerationToolModeration?(string value);
public static bool operator !=(ImageGenerationToolModeration left, ImageGenerationToolModeration right);
public static bool operator ==(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
public static implicit operator ImageGenerationToolModerationLevel(string value);
public static implicit operator ImageGenerationToolModerationLevel?(string value);
public static bool operator !=(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
public override readonly string ToString();
}
[Experimental("OPENAI001")]
public readonly partial struct ImageGenerationToolOutputFormat : IEquatable<ImageGenerationToolOutputFormat> {
public ImageGenerationToolOutputFormat(string value);
public static ImageGenerationToolOutputFormat Jpeg { get; }
public static ImageGenerationToolOutputFormat Png { get; }
public static ImageGenerationToolOutputFormat Webp { get; }
public readonly bool Equals(ImageGenerationToolOutputFormat other);
public readonly partial struct ImageGenerationToolOutputFileFormat : IEquatable<ImageGenerationToolOutputFileFormat> {
public ImageGenerationToolOutputFileFormat(string value);
public static ImageGenerationToolOutputFileFormat Jpeg { get; }
public static ImageGenerationToolOutputFileFormat Png { get; }
public static ImageGenerationToolOutputFileFormat Webp { get; }
public readonly bool Equals(ImageGenerationToolOutputFileFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolOutputFormat left, ImageGenerationToolOutputFormat right);
public static implicit operator ImageGenerationToolOutputFormat(string value);
public static implicit operator ImageGenerationToolOutputFormat?(string value);
public static bool operator !=(ImageGenerationToolOutputFormat left, ImageGenerationToolOutputFormat right);
public static bool operator ==(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
public static implicit operator ImageGenerationToolOutputFileFormat(string value);
public static implicit operator ImageGenerationToolOutputFileFormat?(string value);
public static bool operator !=(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
public override readonly string ToString();
}
[Experimental("OPENAI001")]
Expand All @@ -5091,19 +5111,17 @@ public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolI
}
[Experimental("OPENAI001")]
public readonly partial struct ImageGenerationToolSize : IEquatable<ImageGenerationToolSize> {
public ImageGenerationToolSize(string value);
public static ImageGenerationToolSize _1024x1024 { get; }
public static ImageGenerationToolSize _1024x1536 { get; }
public static ImageGenerationToolSize _1536x1024 { get; }
public static readonly ImageGenerationToolSize W1024xH1024;
public static readonly ImageGenerationToolSize W1024xH1536;
public static readonly ImageGenerationToolSize W1536xH1024;
public ImageGenerationToolSize(int width, int height);
public static ImageGenerationToolSize Auto { get; }
public readonly bool Equals(ImageGenerationToolSize other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(ImageGenerationToolSize left, ImageGenerationToolSize right);
public static implicit operator ImageGenerationToolSize(string value);
public static implicit operator ImageGenerationToolSize?(string value);
public static bool operator !=(ImageGenerationToolSize left, ImageGenerationToolSize right);
public override readonly string ToString();
}
Expand Down Expand Up @@ -5732,8 +5750,9 @@ public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<Response
public static ComputerTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
public static FileSearchTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
public static FunctionTool CreateFunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled, string functionDescription = null);
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFormat? outputFormat = null, int? outputCompression = null, ImageGenerationToolModeration? moderation = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImages = null);
public static McpTool CreateMcpTool(string serverLabel, Uri serverUri, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelityLevel? inputFidelityLevel = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null);
public static McpTool CreateMcpTool(string serverLabel, McpToolConnectorId connectorId, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
public static McpTool CreateMcpTool(string serverLabel, Uri serverUri, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
public static WebSearchTool CreateWebSearchTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null);
protected virtual ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
Expand Down Expand Up @@ -5961,7 +5980,7 @@ public class StreamingResponseImageGenerationCallInProgressUpdate : StreamingRes
public class StreamingResponseImageGenerationCallPartialImageUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallPartialImageUpdate>, IPersistableModel<StreamingResponseImageGenerationCallPartialImageUpdate> {
public string ItemId { get; }
public int OutputIndex { get; }
public string PartialImageB64 { get; }
public BinaryData PartialImageBytes { get; }
public int PartialImageIndex { get; }
protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
Expand Down
Loading