Skip to content

Commit 0d0d41b

Browse files
joseharriagajoseharriaga
committed
Rename InputFidelity and ImageResultBytes
1 parent 14e41be commit 0d0d41b

15 files changed

+70
-72
lines changed

‎api/OpenAI.net8.0.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5210,8 +5210,8 @@ public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistable
52105210
}
52115211
[Experimental("OPENAI001")]
52125212
public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
5213-
public ImageGenerationCallResponseItem(BinaryData generatedImageBytes);
5214-
public BinaryData GeneratedImageBytes { get; set; }
5213+
public ImageGenerationCallResponseItem(BinaryData imageResultBytes);
5214+
public BinaryData ImageResultBytes { get; set; }
52155215
public ImageGenerationCallStatus? Status { get; }
52165216
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
52175217
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
@@ -5229,7 +5229,7 @@ public enum ImageGenerationCallStatus {
52295229
public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
52305230
public ImageGenerationTool();
52315231
public ImageGenerationToolBackground? Background { get; set; }
5232-
public ImageGenerationToolInputFidelityLevel? InputFidelityLevel { get; set; }
5232+
public ImageGenerationToolInputFidelity? InputFidelity { get; set; }
52335233
public ImageGenerationToolInputImageMask InputImageMask { get; set; }
52345234
public string Model { get; set; }
52355235
public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
@@ -5261,19 +5261,19 @@ public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>
52615261
public override readonly string ToString();
52625262
}
52635263
[Experimental("OPENAI001")]
5264-
public readonly partial struct ImageGenerationToolInputFidelityLevel : IEquatable<ImageGenerationToolInputFidelityLevel> {
5265-
public ImageGenerationToolInputFidelityLevel(string value);
5266-
public static ImageGenerationToolInputFidelityLevel High { get; }
5267-
public static ImageGenerationToolInputFidelityLevel Low { get; }
5268-
public readonly bool Equals(ImageGenerationToolInputFidelityLevel other);
5264+
public readonly partial struct ImageGenerationToolInputFidelity : IEquatable<ImageGenerationToolInputFidelity> {
5265+
public ImageGenerationToolInputFidelity(string value);
5266+
public static ImageGenerationToolInputFidelity High { get; }
5267+
public static ImageGenerationToolInputFidelity Low { get; }
5268+
public readonly bool Equals(ImageGenerationToolInputFidelity other);
52695269
[EditorBrowsable(EditorBrowsableState.Never)]
52705270
public override readonly bool Equals(object obj);
52715271
[EditorBrowsable(EditorBrowsableState.Never)]
52725272
public override readonly int GetHashCode();
5273-
public static bool operator ==(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
5274-
public static implicit operator ImageGenerationToolInputFidelityLevel(string value);
5275-
public static implicit operator ImageGenerationToolInputFidelityLevel?(string value);
5276-
public static bool operator !=(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
5273+
public static bool operator ==(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
5274+
public static implicit operator ImageGenerationToolInputFidelity(string value);
5275+
public static implicit operator ImageGenerationToolInputFidelity?(string value);
5276+
public static bool operator !=(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
52775277
public override readonly string ToString();
52785278
}
52795279
[Experimental("OPENAI001")]
@@ -6041,7 +6041,7 @@ public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<Response
60416041
public static ComputerTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
60426042
public static FileSearchTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
60436043
public static FunctionTool CreateFunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled, string functionDescription = null);
6044-
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);
6044+
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelity? inputFidelity = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null);
60456045
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);
60466046
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);
60476047
public static WebSearchTool CreateWebSearchTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null);

‎api/OpenAI.netstandard2.0.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4555,8 +4555,8 @@ public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistable
45554555
public override readonly string ToString();
45564556
}
45574557
public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
4558-
public ImageGenerationCallResponseItem(BinaryData generatedImageBytes);
4559-
public BinaryData GeneratedImageBytes { get; set; }
4558+
public ImageGenerationCallResponseItem(BinaryData imageResultBytes);
4559+
public BinaryData ImageResultBytes { get; set; }
45604560
public ImageGenerationCallStatus? Status { get; }
45614561
protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
45624562
protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
@@ -4572,7 +4572,7 @@ public enum ImageGenerationCallStatus {
45724572
public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
45734573
public ImageGenerationTool();
45744574
public ImageGenerationToolBackground? Background { get; set; }
4575-
public ImageGenerationToolInputFidelityLevel? InputFidelityLevel { get; set; }
4575+
public ImageGenerationToolInputFidelity? InputFidelity { get; set; }
45764576
public ImageGenerationToolInputImageMask InputImageMask { get; set; }
45774577
public string Model { get; set; }
45784578
public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
@@ -4602,19 +4602,19 @@ public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>
46024602
public static bool operator !=(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
46034603
public override readonly string ToString();
46044604
}
4605-
public readonly partial struct ImageGenerationToolInputFidelityLevel : IEquatable<ImageGenerationToolInputFidelityLevel> {
4606-
public ImageGenerationToolInputFidelityLevel(string value);
4607-
public static ImageGenerationToolInputFidelityLevel High { get; }
4608-
public static ImageGenerationToolInputFidelityLevel Low { get; }
4609-
public readonly bool Equals(ImageGenerationToolInputFidelityLevel other);
4605+
public readonly partial struct ImageGenerationToolInputFidelity : IEquatable<ImageGenerationToolInputFidelity> {
4606+
public ImageGenerationToolInputFidelity(string value);
4607+
public static ImageGenerationToolInputFidelity High { get; }
4608+
public static ImageGenerationToolInputFidelity Low { get; }
4609+
public readonly bool Equals(ImageGenerationToolInputFidelity other);
46104610
[EditorBrowsable(EditorBrowsableState.Never)]
46114611
public override readonly bool Equals(object obj);
46124612
[EditorBrowsable(EditorBrowsableState.Never)]
46134613
public override readonly int GetHashCode();
4614-
public static bool operator ==(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
4615-
public static implicit operator ImageGenerationToolInputFidelityLevel(string value);
4616-
public static implicit operator ImageGenerationToolInputFidelityLevel?(string value);
4617-
public static bool operator !=(ImageGenerationToolInputFidelityLevel left, ImageGenerationToolInputFidelityLevel right);
4614+
public static bool operator ==(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
4615+
public static implicit operator ImageGenerationToolInputFidelity(string value);
4616+
public static implicit operator ImageGenerationToolInputFidelity?(string value);
4617+
public static bool operator !=(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
46184618
public override readonly string ToString();
46194619
}
46204620
public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolInputImageMask>, IPersistableModel<ImageGenerationToolInputImageMask> {
@@ -5305,7 +5305,7 @@ public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<Response
53055305
public static ComputerTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
53065306
public static FileSearchTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
53075307
public static FunctionTool CreateFunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled, string functionDescription = null);
5308-
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);
5308+
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelity? inputFidelity = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null);
53095309
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);
53105310
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);
53115311
public static WebSearchTool CreateWebSearchTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null);

‎examples/Responses/Example08_OutputAdditionalProperties.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ public void Example08_OutputAdditionalProperties()
2424
ResponseTool.CreateImageGenerationTool(
2525
model: "gpt-image-1",
2626
outputFileFormat: ImageGenerationToolOutputFileFormat.Png,
27-
inputFidelityLevel: ImageGenerationToolInputFidelityLevel.High)
27+
inputFidelity: ImageGenerationToolInputFidelity.High)
2828
}
2929
};
3030

3131
OpenAIResponse response = client.CreateResponse("Generate an image of gray tabby cat hugging an otter with an orange scarf", options);
3232
ImageGenerationCallResponseItem imageGenResponse = (ImageGenerationCallResponseItem)response.OutputItems[1];
33-
BinaryData bytes = imageGenResponse.GeneratedImageBytes;
33+
BinaryData bytes = imageGenResponse.ResultBytes;
3434

3535
using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.png");
3636
bytes.ToStream().CopyTo(stream);

‎examples/Responses/Example08_OutputAdditionalPropertiesAsync.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ public async Task Example08_OutputAdditionalPropertiesAsync()
2525
ResponseTool.CreateImageGenerationTool(
2626
model: "gpt-image-1",
2727
outputFileFormat: ImageGenerationToolOutputFileFormat.Png,
28-
inputFidelityLevel: ImageGenerationToolInputFidelityLevel.High)
28+
inputFidelity: ImageGenerationToolInputFidelity.High)
2929
}
3030
};
3131

3232
OpenAIResponse response = await client.CreateResponseAsync("Generate an image of gray tabby cat hugging an otter with an orange scarf", options);
3333
ImageGenerationCallResponseItem imageGenResponse = (ImageGenerationCallResponseItem)response.OutputItems[1];
34-
BinaryData bytes = imageGenResponse.GeneratedImageBytes;
34+
BinaryData bytes = imageGenResponse.ResultBytes;
3535

3636
using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.png");
3737
bytes.ToStream().CopyTo(stream);

‎specification/client/responses.client.tsp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ using TypeSpec.HttpClient.CSharp;
5353
@@clientName(MCPListToolsItemResource.tools, "ToolDefinitions");
5454

5555
@@visibility(ImageGenToolCallItemResource.status, Lifecycle.Read);
56-
@@clientName(ImageGenToolCallItemResource.result, "GeneratedImageBytes");
56+
@@clientName(ImageGenToolCallItemResource.result, "ImageResultBytes");
5757

5858
// ------------ Tools ------------
5959

‎src/Custom/Responses/Tools/ImageGenerationTool.cs‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ public partial class ImageGenerationTool
1818
[CodeGenMember("Moderation")]
1919
public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
2020

21-
// CUSTOM: Renamed.
22-
[CodeGenMember("InputFidelity")]
23-
public ImageGenerationToolInputFidelityLevel? InputFidelityLevel { get; set; }
24-
2521
// CUSTOM:Renamed.
2622
[CodeGenMember("PartialImages")]
2723
public int? PartialImageCount { get; set; }

‎src/Custom/Responses/Tools/ImageGenerationToolInputfidelityLevel.cs‎ renamed to ‎src/Custom/Responses/Tools/ImageGenerationToolInputFidelity.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
// CUSTOM: Renamed.
44
[CodeGenType("ImageGenToolInputFidelity")]
5-
public readonly partial struct ImageGenerationToolInputFidelityLevel
5+
public readonly partial struct ImageGenerationToolInputFidelity
66
{
77
}

‎src/Custom/Responses/Tools/ResponseTool.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public static CodeInterpreterTool CreateCodeInterpreterTool(CodeInterpreterToolC
115115
/// <summary>
116116
/// Creates a new instance of the <see cref="ImageGenerationTool"/> class.
117117
/// </summary>
118-
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)
118+
public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelity? inputFidelity = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null)
119119
{
120120
return new ImageGenerationTool(
121121
kind: InternalToolType.ImageGeneration,
@@ -127,7 +127,7 @@ public static ImageGenerationTool CreateImageGenerationTool(string model, ImageG
127127
outputCompressionFactor: outputCompressionFactor,
128128
moderationLevel: moderationLevel,
129129
background: background,
130-
inputFidelityLevel: inputFidelityLevel,
130+
inputFidelity: inputFidelity,
131131
inputImageMask: inputImageMask,
132132
partialImageCount: partialImageCount);
133133
}

‎src/Generated/Models/Responses/ImageGenerationCallResponseItem.Serialization.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWri
4646
writer.WritePropertyName("status"u8);
4747
writer.WriteStringValue(Status.Value.ToSerialString());
4848
}
49-
if (Optional.IsDefined(GeneratedImageBytes) && !Patch.Contains("$.result"u8))
49+
if (Optional.IsDefined(ImageResultBytes) && !Patch.Contains("$.result"u8))
5050
{
5151
writer.WritePropertyName("result"u8);
52-
writer.WriteBase64StringValue(GeneratedImageBytes.ToArray(), "D");
52+
writer.WriteBase64StringValue(ImageResultBytes.ToArray(), "D");
5353
}
5454
else
5555
{
@@ -85,7 +85,7 @@ internal static ImageGenerationCallResponseItem DeserializeImageGenerationCallRe
8585
JsonPatch patch = new JsonPatch(data is null ? ReadOnlyMemory<byte>.Empty : data.ToMemory());
8686
#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
8787
ImageGenerationCallStatus? status = default;
88-
BinaryData generatedImageBytes = default;
88+
BinaryData imageResultBytes = default;
8989
foreach (var prop in element.EnumerateObject())
9090
{
9191
if (prop.NameEquals("type"u8))
@@ -107,15 +107,15 @@ internal static ImageGenerationCallResponseItem DeserializeImageGenerationCallRe
107107
{
108108
if (prop.Value.ValueKind == JsonValueKind.Null)
109109
{
110-
generatedImageBytes = null;
110+
imageResultBytes = null;
111111
continue;
112112
}
113-
generatedImageBytes = BinaryData.FromBytes(prop.Value.GetBytesFromBase64("D"));
113+
imageResultBytes = BinaryData.FromBytes(prop.Value.GetBytesFromBase64("D"));
114114
continue;
115115
}
116116
patch.Set([.. "$."u8, .. Encoding.UTF8.GetBytes(prop.Name)], prop.Value.GetUtf8Bytes());
117117
}
118-
return new ImageGenerationCallResponseItem(kind, id, patch, status, generatedImageBytes);
118+
return new ImageGenerationCallResponseItem(kind, id, patch, status, imageResultBytes);
119119
}
120120

121121
BinaryData IPersistableModel<ImageGenerationCallResponseItem>.Write(ModelReaderWriterOptions options) => PersistableModelWriteCore(options);

0 commit comments

Comments
 (0)