Include deprecated code with tests

- keep completion and embedding calls with old api in client
- Keep tests
- improve test for reusability

Author: rpanackal

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

@@ -10,12 +10,17 @@
 import com.sap.ai.sdk.core.common.ClientResponseHandler;
 import com.sap.ai.sdk.core.common.ClientStreamingHandler;
 import com.sap.ai.sdk.core.common.StreamedDelta;
+import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionOutput;
+import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionParameters;
+import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingOutput;
+import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiEmbeddingParameters;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionStreamOptions;
 import com.sap.ai.sdk.foundationmodels.openai.model2.ChatCompletionsCreate200Response;
 import com.sap.ai.sdk.foundationmodels.openai.model2.CreateChatCompletionRequest;
 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;
@@ -110,13 +115,6 @@ public static OpenAiClient withCustomDestination(@Nonnull final Destination dest
     return client.withApiVersion(DEFAULT_API_VERSION);
   }
 
-  private static void throwOnContentFilter(@Nonnull final OpenAiChatCompletionDelta delta) {
-    final String finishReason = delta.getFinishReason();
-    if (finishReason != null && finishReason.equals("content_filter")) {
-      throw new OpenAiClientException("Content filter filtered the output.");
-    }
-  }
-
   /**
    * Use this method to set a system prompt that should be used across multiple chat completions
    * with basic string prompts {@link #streamChatCompletionDeltas(OpenAiChatCompletionRequest)}.
@@ -153,32 +151,39 @@ public OpenAiChatCompletionResponse chatCompletion(@Nonnull final String prompt)
     return chatCompletion(request.toCreateChatCompletionRequest());
   }
 
+  private static void throwOnContentFilter(@Nonnull final OpenAiChatCompletionDelta delta) {
+    final String finishReason = delta.getFinishReason();
+    if (finishReason != null && finishReason.equals("content_filter")) {
+      throw new OpenAiClientException("Content filter filtered the output.");
+    }
+  }
+
   /**
-   * Generate a completion for the given conversation and other request parameters.
+   * Generate a completion for the given low-level request object.
    *
    * @param request the completion request.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
    */
   @Nonnull
   public OpenAiChatCompletionResponse chatCompletion(
-      @Nonnull final OpenAiChatCompletionRequest request) throws OpenAiClientException {
-    warnIfUnsupportedUsage();
-    return chatCompletion(request.toCreateChatCompletionRequest());
+      @Nonnull final CreateChatCompletionRequest request) throws OpenAiClientException {
+    return new OpenAiChatCompletionResponse(
+        execute("/chat/completions", request, CreateChatCompletionResponse.class));
   }
 
   /**
-   * Generate a completion for the given low-level request object.
+   * Generate a completion for the given conversation and request parameters.
    *
    * @param request the completion request.
    * @return the completion output
    * @throws OpenAiClientException if the request fails
    */
   @Nonnull
   public OpenAiChatCompletionResponse chatCompletion(
-      @Nonnull final CreateChatCompletionRequest request) throws OpenAiClientException {
-    return new OpenAiChatCompletionResponse(
-        execute("/chat/completions", request, CreateChatCompletionResponse.class));
+      @Nonnull final OpenAiChatCompletionRequest request) throws OpenAiClientException {
+    warnIfUnsupportedUsage();
+    return chatCompletion(request.toCreateChatCompletionRequest());
   }
 
   /**
@@ -223,7 +228,23 @@ public Stream<String> streamChatCompletion(@Nonnull final String prompt)
   }
 
   /**
-   * Stream a completion for the given conversation and other request parameters.
+   * Generate a completion for the given conversation and request parameters.
+   *
+   * @param parameters the completion request.
+   * @return the completion output
+   * @throws OpenAiClientException if the request fails
+   * @deprecated Use {@link #chatCompletion(OpenAiChatCompletionRequest)} instead.
+   */
+  @Deprecated(since = "1.3.0")
+  @Nonnull
+  public OpenAiChatCompletionOutput chatCompletion(
+      @Nonnull final OpenAiChatCompletionParameters parameters) throws OpenAiClientException {
+    warnIfUnsupportedUsage();
+    return execute("/chat/completions", parameters, OpenAiChatCompletionOutput.class);
+  }
+
+  /**
+   * Stream a completion for the given conversation and request parameters.
    *
    * <p>Returns a <b>lazily</b> populated stream of delta objects. To simply stream the text chunks
    * use {@link #streamChatCompletion(String)}
@@ -272,13 +293,84 @@ public Stream<OpenAiChatCompletionDelta> streamChatCompletionDeltas(
     return executeStream("/chat/completions", request, OpenAiChatCompletionDelta.class);
   }
 
+  /**
+   * Stream a completion for the given conversation and request parameters.
+   *
+   * <p>Returns a <b>lazily</b> populated stream of delta objects. To simply stream the text chunks
+   * use {@link #streamChatCompletion(String)}
+   *
+   * <p>The stream should be consumed using a try-with-resources block to ensure that the underlying
+   * HTTP connection is closed.
+   *
+   * <p>Example:
+   *
+   * <pre>{@code
+   * try (var stream = client.streamChatCompletionDeltas(prompt)) {
+   *       stream
+   *           .peek(delta -> System.out.println(delta.getUsage()))
+   *           .map(com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionDelta::getDeltaContent)
+   *           .forEach(System.out::println);
+   * }
+   * }</pre>
+   *
+   * <p>Please keep in mind that using a terminal stream operation like {@link Stream#forEach} will
+   * block until all chunks are consumed. Also, for obvious reasons, invoking {@link
+   * Stream#parallel()} on this stream is not supported.
+   *
+   * @param parameters The prompt, including a list of messages.
+   * @return A stream of message deltas
+   * @throws OpenAiClientException if the request fails or if the finish reason is content_filter
+   * @deprecated Use {@link #streamChatCompletionDeltas(OpenAiChatCompletionRequest)} instead.
+   */
+  @Deprecated(since = "1.3.0")
+  @Nonnull
+  public Stream<com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionDelta>
+      streamChatCompletionDeltas(@Nonnull final OpenAiChatCompletionParameters parameters)
+          throws OpenAiClientException {
+    warnIfUnsupportedUsage();
+    parameters.enableStreaming();
+    return executeStream(
+        "/chat/completions",
+        parameters,
+        com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionDelta.class);
+  }
+
   private void warnIfUnsupportedUsage() {
     if (systemPrompt != null) {
       log.warn(
           "Previously set messages will be ignored, set it as an argument of this method instead.");
     }
   }
 
+  /**
+   * Get a vector representation of a given string input that can be easily consumed by machine
+   * learning models and algorithms.
+   *
+   * @param input the input text.
+   * @return the embedding output
+   * @throws OpenAiClientException if the request fails
+   */
+  @Nonnull
+  public EmbeddingsCreate200Response embedding(@Nonnull final String input)
+      throws OpenAiClientException {
+    return embedding(
+        new EmbeddingsCreateRequest().input(EmbeddingsCreateRequestInput.create(input)));
+  }
+
+  /**
+   * Get a vector representation of a given request with input that can be easily consumed by
+   * machine learning models and algorithms.
+   *
+   * @param request the request with input text.
+   * @return the embedding output
+   * @throws OpenAiClientException if the request fails
+   */
+  @Nonnull
+  public EmbeddingsCreate200Response embedding(@Nonnull final EmbeddingsCreateRequest request)
+      throws OpenAiClientException {
+    return execute("/embeddings", request, EmbeddingsCreate200Response.class);
+  }
+
   /**
    * Get a vector representation of a given input that can be easily consumed by machine learning
    * models and algorithms.
@@ -288,9 +380,9 @@ private void warnIfUnsupportedUsage() {
    * @throws OpenAiClientException if the request fails
    */
   @Nonnull
-  public EmbeddingsCreate200Response embedding(@Nonnull final EmbeddingsCreateRequest parameters)
+  public OpenAiEmbeddingOutput embedding(@Nonnull final OpenAiEmbeddingParameters parameters)
       throws OpenAiClientException {
-    return execute("/embeddings", parameters, EmbeddingsCreate200Response.class);
+    return execute("/embeddings", parameters, OpenAiEmbeddingOutput.class);
   }
 
   @Nonnull

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

@@ -0,0 +1,89 @@
+package com.sap.ai.sdk.foundationmodels.openai;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
+import static com.github.tomakehurst.wiremock.client.WireMock.post;
+import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
+import com.github.tomakehurst.wiremock.junit5.WireMockTest;
+import com.sap.cloud.sdk.cloudplatform.connectivity.ApacheHttpClient5Accessor;
+import com.sap.cloud.sdk.cloudplatform.connectivity.ApacheHttpClient5Cache;
+import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Objects;
+import java.util.function.Function;
+import org.apache.hc.client5.http.classic.HttpClient;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.io.entity.InputStreamEntity;
+import org.apache.hc.core5.http.message.BasicClassicHttpResponse;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+
+@WireMockTest
+abstract class BaseOpenAiClientTest {
+
+  protected static final ObjectMapper MAPPER = new ObjectMapper();
+  protected static OpenAiClient client;
+  protected final Function<String, InputStream> fileLoader =
+      filename -> Objects.requireNonNull(getClass().getClassLoader().getResourceAsStream(filename));
+
+  static void stubForChatCompletion() {
+
+    stubFor(
+        post(urlPathEqualTo("/chat/completions"))
+            .withQueryParam("api-version", equalTo("2024-02-01"))
+            .willReturn(
+                aResponse()
+                    .withBodyFile("chatCompletionResponse.json")
+                    .withHeader("Content-Type", "application/json")));
+  }
+
+  static void stubForEmbedding() {
+    stubFor(
+        post(urlPathEqualTo("/embeddings"))
+            .willReturn(
+                aResponse()
+                    .withBodyFile("embeddingResponse.json")
+                    .withHeader("Content-Type", "application/json")));
+  }
+
+  @BeforeEach
+  void setup(WireMockRuntimeInfo server) {
+    final DefaultHttpDestination destination =
+        DefaultHttpDestination.builder(server.getHttpBaseUrl()).build();
+    client = OpenAiClient.withCustomDestination(destination);
+    ApacheHttpClient5Accessor.setHttpClientCache(ApacheHttpClient5Cache.DISABLED);
+  }
+
+  @AfterEach
+  void reset() {
+    ApacheHttpClient5Accessor.setHttpClientCache(null);
+    ApacheHttpClient5Accessor.setHttpClientFactory(null);
+  }
+
+  InputStream stubChatCompletionDeltas(String responseFile) throws IOException {
+    var inputStream = spy(fileLoader.apply(responseFile));
+
+    final var httpClient = mock(HttpClient.class);
+    ApacheHttpClient5Accessor.setHttpClientFactory(destination -> httpClient);
+
+    // Create a mock response
+    final var mockResponse = new BasicClassicHttpResponse(200, "OK");
+    final var inputStreamEntity = new InputStreamEntity(inputStream, ContentType.TEXT_PLAIN);
+    mockResponse.setEntity(inputStreamEntity);
+    mockResponse.setHeader("Content-Type", "text/event-stream");
+
+    // Configure the HttpClient mock to return the mock response
+    doReturn(mockResponse).when(httpClient).executeOpen(any(), any(), any());
+
+    return inputStream;
+  }
+}