low-level chatCompletion returns low-level response and change OpenAiChatCompletionResponse access

Author: rpanackal

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

@@ -1,7 +1,7 @@
 package com.sap.ai.sdk.foundationmodels.openai;
 
 import static com.sap.ai.sdk.foundationmodels.openai.model2.CreateChatCompletionResponseChoicesInner.FinishReasonEnum.CONTENT_FILTER;
-import static lombok.AccessLevel.PROTECTED;
+import static lombok.AccessLevel.PACKAGE;
 
 import com.sap.ai.sdk.foundationmodels.openai.model2.CompletionUsage;
 import com.sap.ai.sdk.foundationmodels.openai.model2.CreateChatCompletionResponse;
@@ -13,7 +13,7 @@
 
 /** Represents the output of an OpenAI chat completion. */
 @Data
-@RequiredArgsConstructor(access = PROTECTED)
+@RequiredArgsConstructor(access = PACKAGE)
 public class OpenAiChatCompletionResponse {
   /** The original response from the OpenAI API. */
   @Nonnull final CreateChatCompletionResponse originalResponse;

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

@@ -148,7 +148,8 @@ public OpenAiChatCompletionResponse chatCompletion(@Nonnull final String prompt)
             ? new OpenAiChatCompletionRequest(systemPrompt, userPrompt)
             : new OpenAiChatCompletionRequest(userPrompt);
 
-    return chatCompletion(request.toCreateChatCompletionRequest());
+    return new OpenAiChatCompletionResponse(
+        chatCompletion(request.toCreateChatCompletionRequest()));
   }
 
   private static void throwOnContentFilter(@Nonnull final OpenAiChatCompletionDelta delta) {
@@ -159,31 +160,31 @@ private static void throwOnContentFilter(@Nonnull final OpenAiChatCompletionDelt
   }
 
   /**
-   * 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 {
+      @Nonnull final OpenAiChatCompletionRequest request) throws OpenAiClientException {
+    warnIfUnsupportedUsage();
     return new OpenAiChatCompletionResponse(
-        execute("/chat/completions", request, CreateChatCompletionResponse.class));
+        chatCompletion(request.toCreateChatCompletionRequest()));
   }
 
   /**
-   * Generate a completion for the given conversation and 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());
+  public CreateChatCompletionResponse chatCompletion(
+      @Nonnull final CreateChatCompletionRequest request) throws OpenAiClientException {
+    return execute("/chat/completions", request, CreateChatCompletionResponse.class);
   }
 
   /**

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

@@ -123,7 +123,7 @@ Object chatCompletionImage(
     if ("json".equals(format)) {
       return response;
     }
-    return response.getContent();
+    return response.getChoices().get(0).getMessage();
   }
 
   /**

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

@@ -24,6 +24,7 @@
 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.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;
@@ -97,7 +98,7 @@ public Stream<String> streamChatCompletion(@Nonnull final String message) {
    * @return the assistant message response
    */
   @Nonnull
-  public OpenAiChatCompletionResponse chatCompletionImage(@Nonnull final String linkToImage) {
+  public CreateChatCompletionResponse chatCompletionImage(@Nonnull final String linkToImage) {
     final var partText =
         new ChatCompletionRequestMessageContentPartText()
             .type(TEXT)

sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/OpenAiTest.java

@@ -39,7 +39,7 @@ void chatCompletionImage() {
         service.chatCompletionImage(
             "https://upload.wikimedia.org/wikipedia/commons/thumb/5/59/SAP_2011_logo.svg/440px-SAP_2011_logo.svg.png");
 
-    final var message = completion.getChoice().getMessage();
+    final var message = completion.getChoices().get(0).getMessage();
     assertThat(message.getRole()).isEqualTo(ASSISTANT);
     assertThat(message.getContent()).isNotEmpty();
   }