Add outputFormat and outputCompression to OpenAiSdkImageOptions

Add support for outputFormat and outputCompression parameters in
image generation using the OpenAI SDK. These options allow users
to specify the output format (png, jpeg, webp) and compression
level for generated images.

Changes:
* Add outputFormat and outputCompression fields to OpenAiSdkImageOptions
* Add getters, setters, and builder methods for the new fields
* Update equals, hashCode, and toString methods
* Update toOpenAiImageGenerateParams to include the new parameters
* Update Builder.from() and Builder.merge() to handle new fields
* Add test coverage for the new properties

Signed-off-by: Igor Bari <mucsi96@gmail.com>

Author: mucsi96

auto-configurations/models/spring-ai-autoconfigure-model-openai-sdk/src/test/java/org/springframework/ai/model/openaisdk/autoconfigure/OpenAiSdkImagePropertiesTests.java

@@ -102,7 +102,9 @@ public void imageOptionsTest() {
 				"spring.ai.openai-sdk.image.options.responseFormat=url",
 				"spring.ai.openai-sdk.image.options.size=1024x1792",
 				"spring.ai.openai-sdk.image.options.style=vivid",
-				"spring.ai.openai-sdk.image.options.user=userXYZ"
+				"spring.ai.openai-sdk.image.options.user=userXYZ",
+				"spring.ai.openai-sdk.image.options.outputFormat=jpeg",
+				"spring.ai.openai-sdk.image.options.outputCompression=75"
 			)
 			// @formatter:on
 			.withConfiguration(SpringAiTestAutoConfigurations.of(OpenAiSdkImageAutoConfiguration.class))
@@ -122,6 +124,8 @@ public void imageOptionsTest() {
 				assertThat(imageProperties.getOptions().getSize()).isEqualTo("1024x1792");
 				assertThat(imageProperties.getOptions().getStyle()).isEqualTo("vivid");
 				assertThat(imageProperties.getOptions().getUser()).isEqualTo("userXYZ");
+				assertThat(imageProperties.getOptions().getOutputFormat()).isEqualTo("jpeg");
+				assertThat(imageProperties.getOptions().getOutputCompression()).isEqualTo(75);
 			});
 	}
 

models/spring-ai-openai-sdk/src/main/java/org/springframework/ai/openaisdk/OpenAiSdkImageOptions.java

@@ -82,6 +82,17 @@ public class OpenAiSdkImageOptions extends AbstractOpenAiSdkOptions implements I
 	 */
 	private String user;
 
+	/**
+	 * The output format of the generated images. Must be one of png, jpeg, or webp.
+	 */
+	private String outputFormat;
+
+	/**
+	 * The compression level (0-100) for lossy formats like jpeg and webp. Only applies
+	 * when outputFormat is jpeg or webp.
+	 */
+	private Integer outputCompression;
+
 	public static Builder builder() {
 		return new Builder();
 	}
@@ -160,6 +171,22 @@ public void setStyle(String style) {
 		this.style = style;
 	}
 
+	public String getOutputFormat() {
+		return this.outputFormat;
+	}
+
+	public void setOutputFormat(String outputFormat) {
+		this.outputFormat = outputFormat;
+	}
+
+	public Integer getOutputCompression() {
+		return this.outputCompression;
+	}
+
+	public void setOutputCompression(Integer outputCompression) {
+		this.outputCompression = outputCompression;
+	}
+
 	@Override
 	public boolean equals(Object o) {
 		if (o == null || getClass() != o.getClass()) {
@@ -169,20 +196,23 @@ public boolean equals(Object o) {
 		return Objects.equals(this.n, that.n) && Objects.equals(this.width, that.width)
 				&& Objects.equals(this.height, that.height) && Objects.equals(this.quality, that.quality)
 				&& Objects.equals(this.responseFormat, that.responseFormat) && Objects.equals(this.size, that.size)
-				&& Objects.equals(this.style, that.style) && Objects.equals(this.user, that.user);
+				&& Objects.equals(this.style, that.style) && Objects.equals(this.user, that.user)
+				&& Objects.equals(this.outputFormat, that.outputFormat)
+				&& Objects.equals(this.outputCompression, that.outputCompression);
 	}
 
 	@Override
 	public int hashCode() {
 		return Objects.hash(this.n, this.width, this.height, this.quality, this.responseFormat, this.size, this.style,
-				this.user);
+				this.user, this.outputFormat, this.outputCompression);
 	}
 
 	@Override
 	public String toString() {
 		return "OpenAiSdkImageOptions{" + "n=" + this.n + ", width=" + this.width + ", height=" + this.height
 				+ ", quality='" + this.quality + '\'' + ", responseFormat='" + this.responseFormat + '\'' + ", size='"
-				+ this.size + '\'' + ", style='" + this.style + '\'' + ", user='" + this.user + '\'' + '}';
+				+ this.size + '\'' + ", style='" + this.style + '\'' + ", user='" + this.user + '\''
+				+ ", outputFormat='" + this.outputFormat + '\'' + ", outputCompression=" + this.outputCompression + '}';
 	}
 
 	public ImageGenerateParams toOpenAiImageGenerateParams(ImagePrompt imagePrompt) {
@@ -220,6 +250,12 @@ else if (this.getModel() != null) {
 		if (this.getUser() != null) {
 			builder.user(this.getUser());
 		}
+		if (this.getOutputFormat() != null) {
+			builder.outputFormat(ImageGenerateParams.OutputFormat.of(this.getOutputFormat().toLowerCase()));
+		}
+		if (this.getOutputCompression() != null) {
+			builder.outputCompression(this.getOutputCompression().longValue());
+		}
 
 		return builder.build();
 	}
@@ -256,6 +292,8 @@ public Builder from(OpenAiSdkImageOptions fromOptions) {
 			this.options.setSize(fromOptions.getSize());
 			this.options.setStyle(fromOptions.getStyle());
 			this.options.setUser(fromOptions.getUser());
+			this.options.setOutputFormat(fromOptions.getOutputFormat());
+			this.options.setOutputCompression(fromOptions.getOutputCompression());
 			return this;
 		}
 
@@ -322,6 +360,12 @@ public Builder merge(ImageOptions from) {
 				if (castFrom.getUser() != null) {
 					this.options.setUser(castFrom.getUser());
 				}
+				if (castFrom.getOutputFormat() != null) {
+					this.options.setOutputFormat(castFrom.getOutputFormat());
+				}
+				if (castFrom.getOutputCompression() != null) {
+					this.options.setOutputCompression(castFrom.getOutputCompression());
+				}
 			}
 			return this;
 		}
@@ -421,6 +465,16 @@ public Builder style(String style) {
 			return this;
 		}
 
+		public Builder outputFormat(String outputFormat) {
+			this.options.setOutputFormat(outputFormat);
+			return this;
+		}
+
+		public Builder outputCompression(Integer outputCompression) {
+			this.options.setOutputCompression(outputCompression);
+			return this;
+		}
+
 		public OpenAiSdkImageOptions build() {
 			return this.options;
 		}