Streamline EmbeddingOptions

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

@@ -23,6 +23,7 @@
  * The configuration information for the embedding requests.
  *
  * @author Christian Tzolov
+ * @author Thomas Vitale
  * @since 0.8.0
  */
 public class AzureOpenAiEmbeddingOptions implements EmbeddingOptions {
@@ -123,6 +124,11 @@ public AzureOpenAiEmbeddingOptions build() {
 
 	}
 
+	@Override
+	public String getModel() {
+		return getDeploymentName();
+	}
+
 	public String getUser() {
 		return this.user;
 	}
@@ -147,6 +153,7 @@ public void setInputType(String inputType) {
 		this.inputType = inputType;
 	}
 
+	@Override
 	public Integer getDimensions() {
 		return this.dimensions;
 	}

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/cohere/BedrockCohereEmbeddingOptions.java

@@ -25,6 +25,7 @@
 
 /**
  * @author Christian Tzolov
+ * @author Thomas Vitale
  */
 @JsonInclude(Include.NON_NULL)
 public class BedrockCohereEmbeddingOptions implements EmbeddingOptions {
@@ -86,4 +87,14 @@ public void setTruncate(Truncate truncate) {
 		this.truncate = truncate;
 	}
 
+	@Override
+	public String getModel() {
+		return null;
+	}
+
+	@Override
+	public Integer getDimensions() {
+		return null;
+	}
+
 }

models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/titan/BedrockTitanEmbeddingOptions.java

@@ -24,6 +24,7 @@
 
 /**
  * @author Wei Jiang
+ * @author Thomas Vitale
  */
 @JsonInclude(Include.NON_NULL)
 public class BedrockTitanEmbeddingOptions implements EmbeddingOptions {
@@ -62,4 +63,14 @@ public void setInputType(InputType inputType) {
 		this.inputType = inputType;
 	}
 
+	@Override
+	public String getModel() {
+		return null;
+	}
+
+	@Override
+	public Integer getDimensions() {
+		return null;
+	}
+
 }

models/spring-ai-minimax/src/main/java/org/springframework/ai/minimax/MiniMaxEmbeddingOptions.java

@@ -24,6 +24,7 @@
  * This class represents the options for MiniMax embedding.
  *
  * @author Geng Rong
+ * @author Thomas Vitale
  * @since 1.0.0 M1
  */
 @JsonInclude(Include.NON_NULL)
@@ -59,6 +60,7 @@ public MiniMaxEmbeddingOptions build() {
 
 	}
 
+	@Override
 	public String getModel() {
 		return this.model;
 	}
@@ -67,4 +69,9 @@ public void setModel(String model) {
 		this.model = model;
 	}
 
+	@Override
+	public Integer getDimensions() {
+		return null;
+	}
+
 }

models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/MistralAiEmbeddingOptions.java

@@ -22,6 +22,7 @@
 
 /**
  * @author Ricken Bazolo
+ * @author Thomas Vitale
  * @since 0.8.1
  */
 @JsonInclude(Include.NON_NULL)
@@ -41,6 +42,7 @@ public static Builder builder() {
 		return new Builder();
 	}
 
+	@Override
 	public String getModel() {
 		return this.model;
 	}
@@ -57,6 +59,11 @@ public void setEncodingFormat(String encodingFormat) {
 		this.encodingFormat = encodingFormat;
 	}
 
+	@Override
+	public Integer getDimensions() {
+		return null;
+	}
+
 	public static class Builder {
 
 		protected MistralAiEmbeddingOptions options;

models/spring-ai-ollama/src/main/java/org/springframework/ai/ollama/api/OllamaOptions.java

@@ -498,6 +498,7 @@ public OllamaOptions withFunction(String functionName) {
 	// -------------------
 	// Getters and Setters
 	// -------------------
+	@Override
 	public String getModel() {
 		return model;
 	}
@@ -762,6 +763,11 @@ public void setTruncate(Boolean truncate) {
 		this.truncate = truncate;
 	}
 
+	@Override
+	public Integer getDimensions() {
+		return null;
+	}
+
 	@Override
 	public List<FunctionCallback> getFunctionCallbacks() {
 		return this.functionCallbacks;	

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

@@ -30,7 +30,6 @@
 import org.springframework.ai.embedding.observation.EmbeddingModelObservationConvention;
 import org.springframework.ai.embedding.observation.EmbeddingModelObservationDocumentation;
 import org.springframework.ai.embedding.observation.EmbeddingModelObservationContext;
-import org.springframework.ai.embedding.observation.EmbeddingModelRequestOptions;
 import org.springframework.ai.model.ModelOptionsUtils;
 import org.springframework.ai.observation.AiOperationMetadata;
 import org.springframework.ai.observation.conventions.AiOperationType;
@@ -39,9 +38,9 @@
 import org.springframework.ai.openai.api.OpenAiApi.EmbeddingList;
 import org.springframework.ai.openai.metadata.OpenAiUsage;
 import org.springframework.ai.retry.RetryUtils;
+import org.springframework.lang.Nullable;
 import org.springframework.retry.support.RetryTemplate;
 import org.springframework.util.Assert;
-import org.springframework.util.StringUtils;
 
 import java.util.List;
 
@@ -126,7 +125,7 @@ public OpenAiEmbeddingModel(OpenAiApi openAiApi, MetadataMode metadataMode, Open
 	 */
 	public OpenAiEmbeddingModel(OpenAiApi openAiApi, MetadataMode metadataMode, OpenAiEmbeddingOptions options,
 			RetryTemplate retryTemplate, ObservationRegistry observationRegistry) {
-		Assert.notNull(openAiApi, "OpenAiService must not be null");
+		Assert.notNull(openAiApi, "openAiApi must not be null");
 		Assert.notNull(metadataMode, "metadataMode must not be null");
 		Assert.notNull(options, "options must not be null");
 		Assert.notNull(retryTemplate, "retryTemplate must not be null");
@@ -147,12 +146,13 @@ public List<Double> embed(Document document) {
 
 	@Override
 	public EmbeddingResponse call(EmbeddingRequest request) {
-		org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest<List<String>> apiRequest = createRequest(request);
+		OpenAiEmbeddingOptions requestOptions = mergeOptions(request.getOptions(), this.defaultOptions);
+		OpenAiApi.EmbeddingRequest<List<String>> apiRequest = createRequest(request, requestOptions);
 
 		var observationContext = EmbeddingModelObservationContext.builder()
 			.embeddingRequest(request)
 			.operationMetadata(buildOperationMetadata())
-			.requestOptions(buildRequestOptions(apiRequest))
+			.requestOptions(requestOptions)
 			.build();
 
 		return EmbeddingModelObservationDocumentation.EMBEDDING_MODEL_OPERATION
@@ -183,21 +183,31 @@ public EmbeddingResponse call(EmbeddingRequest request) {
 			});
 	}
 
-	@SuppressWarnings("unchecked")
-	private OpenAiApi.EmbeddingRequest<List<String>> createRequest(EmbeddingRequest request) {
-		org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest<List<String>> apiRequest = (this.defaultOptions != null)
-				? new org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest<>(request.getInstructions(),
-						this.defaultOptions.getModel(), this.defaultOptions.getEncodingFormat(),
-						this.defaultOptions.getDimensions(), this.defaultOptions.getUser())
-				: new org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest<>(request.getInstructions(),
-						OpenAiApi.DEFAULT_EMBEDDING_MODEL);
-
-		if (request.getOptions() != null && !EmbeddingOptions.EMPTY.equals(request.getOptions())) {
-			apiRequest = ModelOptionsUtils.merge(request.getOptions(), apiRequest,
-					org.springframework.ai.openai.api.OpenAiApi.EmbeddingRequest.class);
+	private OpenAiApi.EmbeddingRequest<List<String>> createRequest(EmbeddingRequest request,
+			OpenAiEmbeddingOptions requestOptions) {
+		return new OpenAiApi.EmbeddingRequest<>(request.getInstructions(), requestOptions.getModel(),
+				requestOptions.getEncodingFormat(), requestOptions.getDimensions(), requestOptions.getUser());
+	}
+
+	/**
+	 * Merge runtime and default {@link EmbeddingOptions} to compute the final options to
+	 * use in the request.
+	 */
+	private OpenAiEmbeddingOptions mergeOptions(@Nullable EmbeddingOptions runtimeOptions,
+			OpenAiEmbeddingOptions defaultOptions) {
+		if (runtimeOptions == null) {
+			return defaultOptions;
 		}
 
-		return apiRequest;
+		return OpenAiEmbeddingOptions.builder()
+			// Handle portable embedding options
+			.withModel(ModelOptionsUtils.mergeOption(runtimeOptions.getModel(), defaultOptions.getModel()))
+			.withDimensions(
+					ModelOptionsUtils.mergeOption(runtimeOptions.getDimensions(), defaultOptions.getDimensions()))
+			// Handle OpenAI specific embedding options
+			.withEncodingFormat(defaultOptions.getEncodingFormat())
+			.withUser(defaultOptions.getUser())
+			.build();
 	}
 
 	private AiOperationMetadata buildOperationMetadata() {
@@ -207,14 +217,6 @@ private AiOperationMetadata buildOperationMetadata() {
 			.build();
 	}
 
-	private EmbeddingModelRequestOptions buildRequestOptions(OpenAiApi.EmbeddingRequest<List<String>> request) {
-		return EmbeddingModelRequestOptions.builder()
-			.model(StringUtils.hasText(request.model()) ? request.model() : "unknown")
-			.dimensions(request.dimensions())
-			.encodingFormat(request.encodingFormat())
-			.build();
-	}
-
 	/**
 	 * Use the provided convention for reporting observation data
 	 * @param observationConvention The provided convention

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

@@ -85,6 +85,7 @@ public OpenAiEmbeddingOptions build() {
 
 	}
 
+	@Override
 	public String getModel() {
 		return this.model;
 	}
@@ -101,6 +102,7 @@ public void setEncodingFormat(String encodingFormat) {
 		this.encodingFormat = encodingFormat;
 	}
 
+	@Override
 	public Integer getDimensions() {
 		return this.dimensions;
 	}

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

@@ -190,7 +190,18 @@ public void setResponseFormat(String responseFormat) {
 
 	@Override
 	public Integer getWidth() {
-		return this.width;
+		if (this.width != null) {
+			return this.width;
+		}
+		else if (this.size != null) {
+			try {
+				return Integer.parseInt(this.size.split("x")[0]);
+			}
+			catch (NumberFormatException ex) {
+				return null;
+			}
+		}
+		return null;
 	}
 
 	public void setWidth(Integer width) {
@@ -200,7 +211,18 @@ public void setWidth(Integer width) {
 
 	@Override
 	public Integer getHeight() {
-		return this.height;
+		if (this.height != null) {
+			return this.height;
+		}
+		else if (this.size != null) {
+			try {
+				return Integer.parseInt(this.size.split("x")[1]);
+			}
+			catch (NumberFormatException ex) {
+				return null;
+			}
+		}
+		return null;
 	}
 
 	public void setHeight(Integer height) {
@@ -230,7 +252,6 @@ public void setSize(String size) {
 	}
 
 	public String getSize() {
-
 		if (this.size != null) {
 			return this.size;
 		}

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

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.ai.openai;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Unit tests for {@link OpenAiImageOptions}.
+ *
+ * @author Thomas Vitale
+ */
+class OpenAiImageOptionsTests {
+
+	@Test
+	void whenImageDimensionsAreAllUnset() {
+		OpenAiImageOptions options = new OpenAiImageOptions();
+		assertThat(options.getHeight()).isEqualTo(null);
+		assertThat(options.getWidth()).isEqualTo(null);
+		assertThat(options.getSize()).isEqualTo(null);
+	}
+
+	@Test
+	void whenSizeIsSet() {
+		OpenAiImageOptions options = new OpenAiImageOptions();
+		options.setSize("1920x1080");
+		assertThat(options.getHeight()).isEqualTo(1080);
+		assertThat(options.getWidth()).isEqualTo(1920);
+		assertThat(options.getSize()).isEqualTo("1920x1080");
+	}
+
+	@Test
+	void whenWidthAndHeightAreSet() {
+		OpenAiImageOptions options = new OpenAiImageOptions();
+		options.setWidth(1920);
+		options.setHeight(1080);
+		assertThat(options.getHeight()).isEqualTo(1080);
+		assertThat(options.getWidth()).isEqualTo(1920);
+		assertThat(options.getSize()).isEqualTo("1920x1080");
+	}
+
+	@Test
+	void whenWidthIsSet() {
+		OpenAiImageOptions options = new OpenAiImageOptions();
+		options.setWidth(1920);
+		assertThat(options.getHeight()).isEqualTo(null);
+		assertThat(options.getWidth()).isEqualTo(1920);
+		// This is because "setWidth()" computes "size" without checking for null values.
+		assertThat(options.getSize()).isEqualTo("1920xnull");
+	}
+
+	@Test
+	void whenHeightIsSet() {
+		OpenAiImageOptions options = new OpenAiImageOptions();
+		options.setHeight(1080);
+		assertThat(options.getHeight()).isEqualTo(1080);
+		assertThat(options.getWidth()).isEqualTo(null);
+		// This is because "setHeight()" computes "size" without checking for null values.
+		assertThat(options.getSize()).isEqualTo("nullx1080");
+	}
+
+}