Embedding convenience similar to chat completion request

Author: rpanackal

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

@@ -22,7 +22,6 @@
 import com.sap.ai.sdk.foundationmodels.openai.model2.CreateChatCompletionResponse;
 import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreate200Response;
 import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequest;
-import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequestInput;
 import com.sap.cloud.sdk.cloudplatform.connectivity.ApacheHttpClient5Accessor;
 import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
 import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
@@ -349,19 +348,18 @@ private void warnIfUnsupportedUsage() {
   }
 
   /**
-   * Get a vector representation of a given string input that can be easily consumed by machine
-   * learning models and algorithms.
+   * Get a vector representation of a given convenience request that can be easily consumed by
+   * machine learning models and algorithms.
    *
-   * @param input the input text.
+   * @param request the embedding request.
    * @return the embedding output
    * @throws OpenAiClientException if the request fails
    * @since 1.3.0
    */
   @Nonnull
-  public EmbeddingsCreate200Response embedding(@Nonnull final String input)
+  public EmbeddingsCreate200Response embedding(@Nonnull final OpenAiEmbeddingRequest request)
       throws OpenAiClientException {
-    return embedding(
-        new EmbeddingsCreateRequest().input(EmbeddingsCreateRequestInput.create(input)));
+    return embedding(request.toEmbeddingsCreateRequest());
   }
 
   /**

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

@@ -0,0 +1,57 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequest;
+import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequestInput;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import javax.annotation.Nonnull;
+import lombok.experimental.Accessors;
+
+/**
+ * Represents a request to create embeddings using OpenAI's API.
+ *
+ * @since 1.3.0
+ */
+@Beta
+@Accessors(fluent = true)
+public class OpenAiEmbeddingRequest {
+  /** List of tokens to be embedded. */
+  @Nonnull private final List<String> tokens = new ArrayList<>();
+
+  /**
+   * Constructs an OpenAiEmbeddingRequest with a single token.
+   *
+   * @param token the token to be embedded
+   */
+  public OpenAiEmbeddingRequest(@Nonnull final String token) {
+    tokens.add(token);
+  }
+
+  /**
+   * Constructs an OpenAiEmbeddingRequest with multiple tokens.
+   *
+   * @param token the first token to be embedded
+   * @param tokens additional tokens to be embedded
+   */
+  public OpenAiEmbeddingRequest(@Nonnull final String token, @Nonnull final String... tokens) {
+    this.tokens.add(token);
+    this.tokens.addAll(Arrays.asList(tokens));
+  }
+
+  /**
+   * Converts this request to an EmbeddingsCreateRequest.
+   *
+   * @return an EmbeddingsCreateRequest with the tokens to be embedded
+   */
+  @Nonnull
+  public EmbeddingsCreateRequest toEmbeddingsCreateRequest() {
+    if (tokens.size() == 1) {
+      return new EmbeddingsCreateRequest()
+          .input(EmbeddingsCreateRequestInput.create(tokens.get(0)));
+    }
+
+    return new EmbeddingsCreateRequest().input(EmbeddingsCreateRequestInput.create(tokens));
+  }
+}

foundation-models/openai/src/test/java/com/sap/ai/sdk/foundationmodels/openai/EmbeddingConvenienceTest.java

@@ -0,0 +1,30 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.github.tomakehurst.wiremock.junit5.WireMockTest;
+import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequestInput;
+import org.junit.jupiter.api.Test;
+
+@WireMockTest
+class EmbeddingConvenienceTest {
+
+  @Test
+  void createEmbeddingRequestWithSingleToken() {
+    var request = new OpenAiEmbeddingRequest("token1");
+    var lowLevelRequest = request.toEmbeddingsCreateRequest();
+
+    assertThat(((EmbeddingsCreateRequestInput.InnerString) lowLevelRequest.getInput()))
+        .usingRecursiveComparison()
+        .isEqualTo(EmbeddingsCreateRequestInput.create("token1"));
+  }
+
+  @Test
+  void createEmbeddingRequestWithMultipleTokens() {
+    var request = new OpenAiEmbeddingRequest("token1", "token2", "token3");
+    var lowLevelRequest = request.toEmbeddingsCreateRequest();
+
+    assertThat(((EmbeddingsCreateRequestInput.InnerStrings) lowLevelRequest.getInput()).values())
+        .containsExactly("token1", "token2", "token3");
+  }
+}

foundation-models/openai/src/test/java/com/sap/ai/sdk/foundationmodels/openai/NewOpenAiClientTest.java

@@ -241,7 +241,7 @@ void history() {
   void embedding() {
     stubForEmbedding();
 
-    final var result = client.embedding("Hello World");
+    final var result = client.embedding(new OpenAiEmbeddingRequest("Hello World"));
 
     assertThat(result).isNotNull();
     assertThat(result.getModel()).isEqualTo("ada");

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

@@ -10,15 +10,14 @@
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionRequest;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiChatCompletionResponse;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiClient;
+import com.sap.ai.sdk.foundationmodels.openai.OpenAiEmbeddingRequest;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiImageItem;
 import com.sap.ai.sdk.foundationmodels.openai.OpenAiMessage;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionNamedToolChoice;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionNamedToolChoiceFunction;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionTool;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionToolChoiceOption;
 import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreate200Response;
-import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequest;
-import com.sap.ai.sdk.foundationmodels.openai.model2.EmbeddingsCreateRequestInput;
 import com.sap.ai.sdk.foundationmodels.openai.model2.FunctionObject;
 import java.util.List;
 import java.util.Map;
@@ -126,8 +125,7 @@ public OpenAiChatCompletionResponse chatCompletionTools(@Nonnull final String de
    */
   @Nonnull
   public EmbeddingsCreate200Response embedding(@Nonnull final String input) {
-    final var request =
-        new EmbeddingsCreateRequest().input(EmbeddingsCreateRequestInput.create(input));
+    final var request = new OpenAiEmbeddingRequest(input);
 
     return OpenAiClient.forModel(TEXT_EMBEDDING_ADA_002).embedding(request);
   }