Add review suggestions

Author: rpanackal

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/spring/OpenAiSpringEmbeddingModel.java

@@ -28,8 +28,8 @@
  */
 public class OpenAiSpringEmbeddingModel implements EmbeddingModel {
 
-  private final OpenAiClient client;
-  private final MetadataMode metadataMode;
+  @Nonnull private final OpenAiClient client;
+  @Nonnull private final MetadataMode metadataMode;
 
   /**
    * Constructs an {@code OpenAiSpringEmbeddingModel} with the specified {@link OpenAiClient} of

…OrchestrationSpringAiEmbeddingModel.java …g/OrchestrationSpringEmbeddingModel.javaorchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationSpringAiEmbeddingModel.java renamed to orchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationSpringEmbeddingModel.java orchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationSpringAiEmbeddingModel.java renamed to orchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationSpringEmbeddingModel.java

@@ -28,30 +28,30 @@
  */
 @Beta
 @RequiredArgsConstructor
-public class OrchestrationSpringAiEmbeddingModel implements EmbeddingModel {
+public class OrchestrationSpringEmbeddingModel implements EmbeddingModel {
 
   /**
    * Default embedding options to provide model name and other parameters.
    *
    * <p>Can be overridden by options in the request.
    *
-   * @see OrchestrationSpringAiEmbeddingModel#call(EmbeddingRequest)
+   * @see OrchestrationSpringEmbeddingModel#call(EmbeddingRequest)
    */
-  private final EmbeddingOptions defaultOptions;
+  @Nonnull private final EmbeddingOptions defaultOptions;
 
   /** Client for interacting with the Orchestration SDK. */
-  private final OrchestrationClient client;
+  @Nonnull private final OrchestrationClient client;
 
   /** Metadata mode to determine how document metadata is handled. */
-  private final MetadataMode metadataMode;
+  @Nonnull private final MetadataMode metadataMode;
 
   /**
-   * Constructs an instance with default options, a new {@link OrchestrationClient}, and {@link
-   * MetadataMode#EMBED}.
+   * Constructs an instance with default options, a new {@link OrchestrationClient}, and sets the
+   * metadata mode to {@link MetadataMode#EMBED}.
    *
    * @param defaultOptions Default embedding options.
    */
-  public OrchestrationSpringAiEmbeddingModel(@Nonnull final EmbeddingOptions defaultOptions) {
+  public OrchestrationSpringEmbeddingModel(@Nonnull final EmbeddingOptions defaultOptions) {
     this(defaultOptions, new OrchestrationClient(), MetadataMode.EMBED);
   }
 
@@ -67,7 +67,8 @@ public OrchestrationSpringAiEmbeddingModel(@Nonnull final EmbeddingOptions defau
   @Nonnull
   public EmbeddingResponse call(@Nonnull final EmbeddingRequest request) {
     final var orchestrationRequest = createOrchestrationEmbeddingRequest(request);
-    return createSpringAiEmbeddingResponse(client.embed(orchestrationRequest));
+    final var orchestrationResponse = client.embed(orchestrationRequest);
+    return createSpringAiEmbeddingResponse(orchestrationResponse);
   }
 
   @Override
@@ -80,9 +81,8 @@ public float[] embed(@Nonnull final Document document) {
   @Nonnull
   public List<float[]> embed(@Nonnull final List<String> texts) {
     // Propagate defaultOptions instead of incomplete options in default method implementation
-    return this.call(new EmbeddingRequest(texts, this.defaultOptions)).getResults().stream()
-        .map(Embedding::getOutput)
-        .toList();
+    final var response = this.call(new EmbeddingRequest(texts, this.defaultOptions));
+    return response.getResults().stream().map(Embedding::getOutput).toList();
   }
 
   @Nonnull

orchestration/src/test/java/com/sap/ai/sdk/orchestration/spring/OrchestrationEmbeddingModelTest.java

@@ -31,7 +31,7 @@
 class OrchestrationEmbeddingModelTest {
 
   private static EmbeddingOptions options;
-  private static OrchestrationSpringAiEmbeddingModel model;
+  private static OrchestrationSpringEmbeddingModel model;
   private final Function<String, InputStream> fileLoader =
       filename -> Objects.requireNonNull(getClass().getClassLoader().getResourceAsStream(filename));
 
@@ -41,7 +41,7 @@ void setup(WireMockRuntimeInfo server) {
 
     final var destination = DefaultHttpDestination.builder(server.getHttpBaseUrl()).build();
     final var client = new OrchestrationClient(destination);
-    model = new OrchestrationSpringAiEmbeddingModel(options, client, MetadataMode.EMBED);
+    model = new OrchestrationSpringEmbeddingModel(options, client, MetadataMode.EMBED);
   }
 
   @Test
@@ -55,7 +55,7 @@ void testEmbeddingRequest() throws IOException {
     assertThat(response.getResult().getOutput())
         .isEqualTo(
             new float[] {-0.003806071f, -0.01453408f, 0.037058588f, -0.012397106f, 0.0029582495f});
-    assertThat(response.getMetadata().getModel()).isEqualTo("text-embedding-3-small");
+    assertThat(response.getMetadata().getModel()).isEqualTo(options.getModel());
     assertThat(response.getMetadata().getUsage().getPromptTokens()).isEqualTo(6);
     assertThat(response.getMetadata().getUsage().getTotalTokens()).isEqualTo(6);
 

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/SpringAiOrchestrationController.java

@@ -158,7 +158,7 @@ Object chatMemory(
     return response.getResult().getOutput().getText();
   }
 
-  @GetMapping("/embedding")
+  @GetMapping("/embed/string")
   Object embedding(
       @Nullable @RequestParam(value = "format", required = false) final String format) {
     return service.embed("Hello, world!");

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/SpringAiOrchestrationService.java

@@ -9,11 +9,12 @@
 import com.sap.ai.sdk.orchestration.AzureFilterThreshold;
 import com.sap.ai.sdk.orchestration.DpiMasking;
 import com.sap.ai.sdk.orchestration.OrchestrationClientException;
+import com.sap.ai.sdk.orchestration.OrchestrationEmbeddingModel;
 import com.sap.ai.sdk.orchestration.OrchestrationModuleConfig;
 import com.sap.ai.sdk.orchestration.model.DPIEntities;
 import com.sap.ai.sdk.orchestration.spring.OrchestrationChatModel;
 import com.sap.ai.sdk.orchestration.spring.OrchestrationChatOptions;
-import com.sap.ai.sdk.orchestration.spring.OrchestrationSpringAiEmbeddingModel;
+import com.sap.ai.sdk.orchestration.spring.OrchestrationSpringEmbeddingModel;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -275,7 +276,9 @@ public Translation responseFormat() {
   @Nonnull
   public float[] embed(@Nonnull final String inputText) {
     val embedOptions =
-        EmbeddingOptionsBuilder.builder().withModel("text-embedding-3-small").build();
-    return new OrchestrationSpringAiEmbeddingModel(embedOptions).embed(inputText);
+        EmbeddingOptionsBuilder.builder()
+            .withModel(OrchestrationEmbeddingModel.TEXT_EMBEDDING_3_SMALL.name())
+            .build();
+    return new OrchestrationSpringEmbeddingModel(embedOptions).embed(inputText);
   }
 }

sample-code/spring-app/src/main/resources/static/index.html

@@ -714,6 +714,19 @@ <h2>Spring AI</h2>
                             <h5 class="mb-1">Orchestration Integration</h5>
                         </div>
                         <ul class="list-group">
+                            <li class="list-group-item">
+                                <div class="info-tooltip">
+                                    <button type="submit"
+                                            formaction="/spring-ai-orchestration/embed/string"
+                                            class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
+                                        <code>/spring-ai-orchestration/embed/string</code>
+                                    </button>
+                                    <div class="tooltip-content">
+                                        Embedding request to an embedding model through the Orchestration service
+                                        with a simple prompt.
+                                    </div>
+                                </div>
+                            </li>
                             <li class="list-group-item">
                                 <div class="info-tooltip">
                                     <button type="submit"