Add documentation for Image Generation

- Refine StabilityAI classes
- Add documentation

Author: markpollack

models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiImageOptions.java

@@ -21,6 +21,8 @@
 import org.springframework.ai.image.ImageOptions;
 import org.springframework.ai.openai.api.OpenAiImageApi;
 
+import java.util.Objects;
+
 /**
  * OpenAI Image API options. OpenAiImageOptions.java
  *
@@ -44,6 +46,18 @@ public class OpenAiImageOptions implements ImageOptions {
 	@JsonProperty("model")
 	private String model = OpenAiImageApi.DEFAULT_IMAGE_MODEL;
 
+	/**
+	 * The width of the generated images. Must be one of 256, 512, or 1024 for dall-e-2.
+	 */
+	@JsonProperty("size_width")
+	private Integer width;
+
+	/**
+	 * The height of the generated images. Must be one of 256, 512, or 1024 for dall-e-2.
+	 */
+	@JsonProperty("size_height")
+	private Integer height;
+
 	/**
 	 * The quality of the image that will be generated. hd creates images with finer
 	 * details and greater consistency across the image. This param is only supported for
@@ -66,18 +80,6 @@ public class OpenAiImageOptions implements ImageOptions {
 	@JsonProperty("size")
 	private String size;
 
-	/**
-	 * The width of the generated images. Must be one of 256, 512, or 1024 for dall-e-2.
-	 */
-	@JsonProperty("size_width")
-	private Integer width;
-
-	/**
-	 * The height of the generated images. Must be one of 256, 512, or 1024 for dall-e-2.
-	 */
-	@JsonProperty("size_height")
-	private Integer height;
-
 	/**
 	 * The style of the generated images. Must be one of vivid or natural. Vivid causes
 	 * the model to lean towards generating hyper-real and dramatic images. Natural causes
@@ -235,4 +237,28 @@ public String getSize() {
 		return (this.width != null && this.height != null) ? this.width + "x" + this.height : null;
 	}
 
+	@Override
+	public boolean equals(Object o) {
+		if (this == o)
+			return true;
+		if (!(o instanceof OpenAiImageOptions that))
+			return false;
+		return Objects.equals(n, that.n) && Objects.equals(model, that.model) && Objects.equals(width, that.width)
+				&& Objects.equals(height, that.height) && Objects.equals(quality, that.quality)
+				&& Objects.equals(responseFormat, that.responseFormat) && Objects.equals(size, that.size)
+				&& Objects.equals(style, that.style) && Objects.equals(user, that.user);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(n, model, width, height, quality, responseFormat, size, style, user);
+	}
+
+	@Override
+	public String toString() {
+		return "OpenAiImageOptions{" + "n=" + n + ", model='" + model + '\'' + ", width=" + width + ", height=" + height
+				+ ", quality='" + quality + '\'' + ", responseFormat='" + responseFormat + '\'' + ", size='" + size
+				+ '\'' + ", style='" + style + '\'' + ", user='" + user + '\'' + '}';
+	}
+
 }

models/spring-ai-stabilityai/src/main/java/org/springframework/ai/stabilityai/StabilityAiImageClient.java

@@ -21,8 +21,6 @@
 import org.springframework.ai.model.ModelOptionsUtils;
 import org.springframework.ai.stabilityai.api.StabilityAiApi;
 import org.springframework.ai.stabilityai.api.StabilityAiImageOptions;
-import org.springframework.ai.stabilityai.api.StabilityAiImageOptionsBuilder;
-import org.springframework.ai.stabilityai.api.StabilityAiImageOptionsImpl;
 import org.springframework.util.Assert;
 
 import java.util.List;
@@ -41,7 +39,7 @@ public class StabilityAiImageClient implements ImageClient {
 	private final StabilityAiApi stabilityAiApi;
 
 	public StabilityAiImageClient(StabilityAiApi stabilityAiApi) {
-		this(stabilityAiApi, StabilityAiImageOptionsBuilder.builder().build());
+		this(stabilityAiApi, StabilityAiImageOptions.builder().build());
 	}
 
 	public StabilityAiImageClient(StabilityAiApi stabilityAiApi, StabilityAiImageOptions options) {
@@ -71,7 +69,7 @@ public ImageResponse call(ImagePrompt imagePrompt) {
 		// options configured via Autoconfiguration.
 		// Runtime options overwrite StabilityAiImageClient options
 		StabilityAiImageOptions optionsToUse = ModelOptionsUtils.merge(runtimeOptions, this.options,
-				StabilityAiImageOptionsImpl.class);
+				StabilityAiImageOptions.class);
 
 		// Copy the org.springframework.ai.model derived ImagePrompt and ImageOptions data
 		// types to the data types used in StabilityAiApi
@@ -100,7 +98,7 @@ private static StabilityAiApi.GenerateImageRequest getGenerateImageRequest(Image
 			.withCfgScale(optionsToUse.getCfgScale())
 			.withClipGuidancePreset(optionsToUse.getClipGuidancePreset())
 			.withSampler(optionsToUse.getSampler())
-			.withSamples(optionsToUse.getSamples())
+			.withSamples(optionsToUse.getN())
 			.withSeed(optionsToUse.getSeed())
 			.withSteps(optionsToUse.getSteps())
 			.withStylePreset(optionsToUse.getStylePreset())
@@ -118,7 +116,7 @@ private ImageResponse convertResponse(StabilityAiApi.GenerateImageResponse gener
 	}
 
 	private StabilityAiImageOptions convertOptions(ImageOptions runtimeOptions) {
-		StabilityAiImageOptionsBuilder builder = StabilityAiImageOptionsBuilder.builder();
+		StabilityAiImageOptions.Builder builder = StabilityAiImageOptions.builder();
 		if (runtimeOptions == null) {
 			return builder.build();
 		}