fix tests and code

Signed-off-by: Alexandros Pappas <[email protected]>

Author: apappascs

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

@@ -134,21 +134,17 @@ public Flux<OpenAiImageStreamEvent> streamImage(OpenAiImageRequest imageRequest)
 			.bodyValue(imageRequest)
 			.retrieve()
 			.bodyToFlux(String.class)
-			// Parse the JSON event data
+			// Parse the JSON event data - each chunk is a complete JSON object
 			.mapNotNull(content -> {
 				try {
-					// SSE format: "event: image_generation.partial_image\ndata: {json}"
-					// or "event: image_generation.completed\ndata: {json}"
-					// We only care about the data line
-					if (content.startsWith("data:")) {
-						String jsonData = content.substring(5).trim();
-						return this.objectMapper.readValue(jsonData, OpenAiImageStreamEvent.class);
+					// Skip empty lines
+					if (content == null || content.trim().isEmpty()) {
+						return null;
 					}
-					// Skip event type lines and empty lines
-					return null;
+					return this.objectMapper.readValue(content.trim(), OpenAiImageStreamEvent.class);
 				}
 				catch (JsonProcessingException ex) {
-					throw new RuntimeException("Failed to parse streaming image event", ex);
+					throw new RuntimeException("Failed to parse streaming image event: " + content, ex);
 				}
 			})
 			// Complete the stream after receiving the "image_generation.completed" event

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/image/OpenAiImageModelObservationIT.java

@@ -58,7 +58,7 @@ public class OpenAiImageModelObservationIT {
 	@Test
 	void observationForImageOperation() {
 		var options = OpenAiImageOptions.builder()
-			.model(OpenAiImageApi.ImageModel.GPT_IMAGE_1_MINI.getValue())
+			.model(OpenAiImageApi.ImageModel.DALL_E_3.getValue())
 			.height(1024)
 			.width(1024)
 			.responseFormat("url")
@@ -76,12 +76,12 @@ void observationForImageOperation() {
 			.doesNotHaveAnyRemainingCurrentObservation()
 			.hasObservationWithNameEqualTo(DefaultImageModelObservationConvention.DEFAULT_NAME)
 			.that()
-			.hasContextualNameEqualTo("image " + OpenAiImageApi.ImageModel.GPT_IMAGE_1_MINI.getValue())
+			.hasContextualNameEqualTo("image " + OpenAiImageApi.ImageModel.DALL_E_3.getValue())
 			.hasLowCardinalityKeyValue(LowCardinalityKeyNames.AI_OPERATION_TYPE.asString(),
 					AiOperationType.IMAGE.value())
 			.hasLowCardinalityKeyValue(LowCardinalityKeyNames.AI_PROVIDER.asString(), AiProvider.OPENAI.value())
 			.hasLowCardinalityKeyValue(LowCardinalityKeyNames.REQUEST_MODEL.asString(),
-					OpenAiImageApi.ImageModel.GPT_IMAGE_1_MINI.getValue())
+					OpenAiImageApi.ImageModel.DALL_E_3.getValue())
 			.hasHighCardinalityKeyValue(HighCardinalityKeyNames.REQUEST_IMAGE_SIZE.asString(), "1024x1024")
 			.hasHighCardinalityKeyValue(HighCardinalityKeyNames.REQUEST_IMAGE_RESPONSE_FORMAT.asString(), "url")
 			.hasBeenStarted()

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/image/OpenAiImageModelStreamingIT.java

@@ -63,7 +63,7 @@ void streamImageWithGptImage1MiniAndPartialImages() {
 			.background("opaque")
 			.moderation("auto")
 			.outputCompression(90)
-			.outputFormat("png")
+			.outputFormat("jpeg")
 			.partialImages(2)
 			.stream(true)
 			.build();
@@ -77,12 +77,13 @@ void streamImageWithGptImage1MiniAndPartialImages() {
 		List<ImageResponse> responses = new ArrayList<>();
 		StepVerifier.create(imageStream)
 			.recordWith(() -> responses)
-			.expectNextCount(3) // 2 partial + 1 final
+			.expectNextCount(1) // At least 1 event (final image is guaranteed)
+			.thenConsumeWhile(response -> true) // Consume any additional partial images
 			.verifyComplete();
 
 		// Verify we received responses
 		assertThat(responses).isNotEmpty();
-		assertThat(responses.size()).isGreaterThanOrEqualTo(1);
+		assertThat(responses.size()).isGreaterThanOrEqualTo(1); // At least final image
 
 		// Verify each response has proper structure
 		for (ImageResponse response : responses) {
@@ -99,14 +100,15 @@ void streamImageWithGptImage1MiniAndPartialImages() {
 	@Test
 	void streamImageWithGptImage1() {
 		// Create prompt with streaming options and 1 partial image
+		// Using JPEG for compression < 100 (PNG only supports compression=100)
 		OpenAiImageOptions options = OpenAiImageOptions.builder()
 			.model(ImageModel.GPT_IMAGE_1.getValue())
 			.quality("high")
 			.size("1024x1024")
-			.background("transparent")
+			.background("opaque") // JPEG doesn't support transparency
 			.moderation("auto")
 			.outputCompression(85)
-			.outputFormat("png")
+			.outputFormat("jpeg")
 			.partialImages(1)
 			.stream(true)
 			.build();
@@ -209,7 +211,7 @@ void streamImageVerifyResponseMetadata() {
 			.quality("medium")
 			.size("1024x1024")
 			.background("transparent")
-			.outputCompression(90)
+			.outputCompression(100) // PNG only supports compression=100
 			.outputFormat("png")
 			.partialImages(1)
 			.stream(true)
@@ -219,17 +221,24 @@ void streamImageVerifyResponseMetadata() {
 
 		Flux<ImageResponse> imageStream = this.openAiImageModel.stream(prompt);
 
-		StepVerifier.create(imageStream.takeLast(1)) // Take only the final event
-			.assertNext(response -> {
-				assertThat(response.getResults()).hasSize(1);
-				assertThat(response.getResult()).isNotNull();
-				assertThat(response.getResult().getOutput()).isNotNull();
-				assertThat(response.getResult().getOutput().getB64Json()).isNotEmpty();
-
-				// Verify metadata is present
-				assertThat(response.getMetadata()).isNotNull();
-				assertThat(response.getMetadata().getCreated()).isNotNull();
-			})
+		// Collect all events to ensure we get the final one
+		StepVerifier.create(imageStream).expectNextMatches(response -> {
+			// Verify response structure
+			assertThat(response.getResults()).hasSize(1);
+			assertThat(response.getResult()).isNotNull();
+			assertThat(response.getResult().getOutput()).isNotNull();
+
+			// Verify image data is present
+			Image image = response.getResult().getOutput();
+			assertThat(image.getB64Json()).isNotEmpty();
+
+			// Verify metadata is present
+			assertThat(response.getMetadata()).isNotNull();
+			assertThat(response.getMetadata().getCreated()).isNotNull();
+
+			return true;
+		})
+			.thenConsumeWhile(response -> true) // Consume any remaining events
 			.verifyComplete();
 	}
 

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/image/api/OpenAiImageApiIT.java

@@ -54,7 +54,13 @@ void createImageWithAllModels(ImageModel model) {
 		assertThat(response.getBody()).isNotNull();
 		assertThat(response.getBody().created()).isPositive();
 		assertThat(response.getBody().data()).isNotEmpty();
-		assertThat(response.getBody().data().get(0).url()).isNotEmpty();
+
+		// GPT-Image models return b64_json, DALL-E models can return url
+		boolean hasUrl = response.getBody().data().get(0).url() != null
+				&& !response.getBody().data().get(0).url().isEmpty();
+		boolean hasB64Json = response.getBody().data().get(0).b64Json() != null
+				&& !response.getBody().data().get(0).b64Json().isEmpty();
+		assertThat(hasUrl || hasB64Json).withFailMessage("Response must contain either url or b64_json").isTrue();
 	}
 
 	@ParameterizedTest(name = "{0} : {displayName}")
@@ -166,10 +172,13 @@ void createMultipleImagesWithDallE2() {
 
 	@Test
 	void gptImage1WithAllParameters() {
-		// Test GPT-Image-1 with all supported parameters
+		// Test GPT-Image-1 with all supported parameters (except partial which requires
+		// streaming)
+		// Using JPEG format to test compression parameter (Compression less than 100 is
+		// not supported for PNG output format)
 		OpenAiImageRequest request = new OpenAiImageRequest("A red apple floating in space",
-				ImageModel.GPT_IMAGE_1.getValue(), 1, "high", null, "1024x1024", null, "test-user", "transparent",
-				"auto", 85, "png", 3, false);
+				ImageModel.GPT_IMAGE_1.getValue(), 1, "high", null, "1024x1024", null, "test-user", "opaque", "auto",
+				85, "jpeg", null, false);
 
 		ResponseEntity<OpenAiImageResponse> response = this.openAiImageApi.createImage(request);
 
@@ -181,10 +190,11 @@ void gptImage1WithAllParameters() {
 
 	@Test
 	void gptImage1MiniWithAllParameters() {
-		// Test GPT-Image-1-Mini with all supported parameters
+		// Test GPT-Image-1-Mini with all supported parameters (except partial which
+		// requires streaming)
 		OpenAiImageRequest request = new OpenAiImageRequest("A sunset over the ocean",
 				ImageModel.GPT_IMAGE_1_MINI.getValue(), 1, "medium", null, "1024x1024", null, "test-user", "opaque",
-				"low", 70, "jpeg", 3, false);
+				"low", 70, "jpeg", null, false);
 
 		ResponseEntity<OpenAiImageResponse> response = this.openAiImageApi.createImage(request);
 
@@ -195,11 +205,12 @@ void gptImage1MiniWithAllParameters() {
 	}
 
 	@Test
-	void gptImage1MiniWithAllParametersAndStreamTrue() {
-		// Test GPT-Image-1-Mini with all supported parameters and stream enabled
+	void gptImage1MiniWithAllParametersNonStreaming() {
+		// Test GPT-Image-1-Mini with all supported parameters (non-streaming)
+		// Note: stream and partial parameters are not used for createImage() method
 		OpenAiImageRequest request = new OpenAiImageRequest("A colorful abstract pattern",
 				ImageModel.GPT_IMAGE_1_MINI.getValue(), 1, "auto", null, "1024x1024", null, "test-user", "auto", "auto",
-				90, "png", 3, true);
+				null, "jpeg", null, false);
 
 		ResponseEntity<OpenAiImageResponse> response = this.openAiImageApi.createImage(request);
 

models/spring-ai-openai/src/test/java/org/springframework/ai/openai/image/api/OpenAiImageApiStreamingIT.java

@@ -48,9 +48,10 @@ public class OpenAiImageApiStreamingIT {
 	@Test
 	void streamImageWithGptImage1Mini() {
 		// Create a streaming request with partial images
+		// Using JPEG format to support compression < 100
 		OpenAiImageRequest request = new OpenAiImageRequest("A simple red circle",
 				ImageModel.GPT_IMAGE_1_MINI.getValue(), 1, "medium", null, "1024x1024", null, "test-user", "opaque",
-				"auto", 90, "png", 2, true);
+				"auto", 90, "jpeg", 2, true);
 
 		Flux<OpenAiImageStreamEvent> eventStream = this.openAiImageApi.streamImage(request);
 
@@ -84,10 +85,11 @@ void streamImageWithGptImage1Mini() {
 	}
 
 	@Test
-	void streamImageWithGptImage1() {
+	void streamImageWithGptImage1MiniOnePartialImage() {
 		// Create a streaming request with 1 partial image
-		OpenAiImageRequest request = new OpenAiImageRequest("A blue square", ImageModel.GPT_IMAGE_1.getValue(), 1,
-				"high", null, "1024x1024", null, "test-user", "auto", "auto", 100, "png", 1, true);
+		// Note: Only GPT-Image models support streaming (not DALL-E)
+		OpenAiImageRequest request = new OpenAiImageRequest("A blue square", ImageModel.GPT_IMAGE_1_MINI.getValue(), 1,
+				"medium", null, "1024x1024", null, null, "opaque", "auto", 85, "jpeg", 1, true);
 
 		Flux<OpenAiImageStreamEvent> eventStream = this.openAiImageApi.streamImage(request);
 
@@ -124,8 +126,9 @@ void streamImageWithNoPartialImages() {
 	@Test
 	void streamImageVerifyMetadata() {
 		// Test that all metadata fields are populated correctly
+		// Using compression=100 for PNG (PNG only supports compression=100)
 		OpenAiImageRequest request = new OpenAiImageRequest("A yellow star", ImageModel.GPT_IMAGE_1_MINI.getValue(), 1,
-				"medium", null, "1024x1024", null, "test-user", "transparent", "auto", 90, "png", 1, true);
+				"medium", null, "1024x1024", null, "test-user", "transparent", "auto", 100, "png", 1, true);
 
 		Flux<OpenAiImageStreamEvent> eventStream = this.openAiImageApi.streamImage(request);
 

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/image/openai-image.adoc

@@ -144,9 +144,9 @@ The prefix `spring.ai.openai.image` is the property prefix that lets you configu
 | `spring.ai.openai.image.options.user`       | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. | -
 | `spring.ai.openai.image.options.background` | The background type for the generated image. Must be one of `transparent`, `opaque`, or `auto` (default). Only supported for GPT-Image models. | -
 | `spring.ai.openai.image.options.moderation` | The level of content moderation to apply. Must be one of `low` or `auto` (default). Only supported for GPT-Image models. | -
-| `spring.ai.openai.image.options.output_compression` | The compression level for the output image. Integer between 0-100. Only supported for GPT-Image models. | -
+| `spring.ai.openai.image.options.output_compression` | The compression level for the output image. Integer between 0-100. Only supported for GPT-Image models. NOTE: Compression less than 100 is not supported for PNG output format. | -
 | `spring.ai.openai.image.options.output_format` | The format of the output image. Must be one of `png`, `jpeg`, or `webp`. Only supported for GPT-Image models. | -
-| `spring.ai.openai.image.options.partial_images` | The number of partial images to generate during streaming. Must be between 0 and 3. Only supported for GPT-Image models with streaming enabled. | -
+| `spring.ai.openai.image.options.partial_images` | The number of partial images to generate during streaming. Must be between 0 and 3. Only supported for GPT-Image models with streaming enabled. NOTE: Partial images are only supported with streaming (`stream=true`). | -
 | `spring.ai.openai.image.options.stream`     | Enable streaming image generation. When `true`, partial images are sent as they are generated. Only supported for GPT-Image models. | false
 |====
 
@@ -218,13 +218,17 @@ imageStream.subscribe(response -> {
 | Parameter | Description | Default
 
 | `stream` | Enable streaming mode. Must be `true` for streaming. | false
-| `partialImages` | Number of partial images to send during generation. Must be between 0 and 3. | 0
+| `partialImages` | Number of partial images to send during generation. Must be between 0 and 3. Only valid when `stream=true`. | 0
 | `outputCompression` | Compression level for streamed images (0-100). Lower values mean faster streaming but larger file sizes. | -
 | `outputFormat` | Format for streamed images: `png`, `jpeg`, or `webp`. | -
 |====
 
 IMPORTANT: The `partialImages` parameter must be between 0 and 3. Values above 3 will result in an error.
 
+IMPORTANT: Partial images are only supported with streaming enabled (`stream=true`). Setting `partialImages` without `stream=true` will result in an error.
+
+IMPORTANT: Compression levels below 100 are not supported for PNG output format. Use JPEG or WebP format if you need compression below 100.
+
 === Understanding Partial Images
 
 - **partialImages = 0**: Only the final completed image is streamed