Renaming and adding tests.

Author: Jonas-Isr

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

@@ -40,6 +40,9 @@ public class OpenAiChatCompletionOutput extends OpenAiCompletionOutput
    */
   @Nonnull
   public String getContent() throws OpenAiClientException {
+    if (getChoices().isEmpty()) {
+      return "";
+    }
     if ("content_filter".equals(getChoices().get(0).getFinishReason())) {
       throw new OpenAiClientException("Content filter filtered the output.");
     }

…orchestration/OrchestrationResponse.java …estration/OrchestrationChatResponse.javaorchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationResponse.java renamed to orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationChatResponse.java orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationResponse.java renamed to orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationChatResponse.java

@@ -11,8 +11,8 @@
 /** Orchestration chat completion output. */
 @Value
 @RequiredArgsConstructor(access = PACKAGE)
-public class OrchestrationResponse {
-  CompletionPostResponse data;
+public class OrchestrationChatResponse {
+  CompletionPostResponse originalResponse;
 
   /**
    * Get the message content from the output.
@@ -24,8 +24,14 @@ public class OrchestrationResponse {
    */
   @Nonnull
   public String getContent() throws OrchestrationClientException {
-    final var choice =
-        ((LLMModuleResultSynchronous) data.getOrchestrationResult()).getChoices().get(0);
+    final var choices =
+        ((LLMModuleResultSynchronous) originalResponse.getOrchestrationResult()).getChoices();
+
+    if (choices.isEmpty()) {
+      return "";
+    }
+
+    final var choice = choices.get(0);
 
     if ("content_filter".equals(choice.getFinishReason())) {
       throw new OrchestrationClientException("Content filter filtered the output.");

orchestration/src/main/java/com/sap/ai/sdk/orchestration/OrchestrationClient.java

@@ -101,12 +101,12 @@ public static CompletionPostRequest toCompletionPostRequest(
    * @throws OrchestrationClientException if the request fails.
    */
   @Nonnull
-  public OrchestrationResponse chatCompletion(
+  public OrchestrationChatResponse chatCompletion(
       @Nonnull final OrchestrationPrompt prompt, @Nonnull final OrchestrationModuleConfig config)
       throws OrchestrationClientException {
 
     val request = toCompletionPostRequest(prompt, config);
-    return new OrchestrationResponse(executeRequest(request));
+    return new OrchestrationChatResponse(executeRequest(request));
   }
 
   /**

orchestration/src/test/java/com/sap/ai/sdk/orchestration/OrchestrationUnitTest.java

@@ -140,7 +140,7 @@ void testTemplating() throws IOException {
     final var result =
         client.chatCompletion(new OrchestrationPrompt(inputParams, template), config);
 
-    final var response = result.getData();
+    final var response = result.getOriginalResponse();
     assertThat(response.getRequestId()).isEqualTo("26ea36b5-c196-4806-a9a6-a686f0c6ad91");
     assertThat(response.getModuleResults().getTemplating().get(0).getContent())
         .isEqualTo("Reply with 'Orchestration Service is working!' in German");
@@ -286,7 +286,8 @@ void messagesHistory() throws IOException {
 
     final var result = client.chatCompletion(prompt, config);
 
-    assertThat(result.getData().getRequestId()).isEqualTo("26ea36b5-c196-4806-a9a6-a686f0c6ad91");
+    assertThat(result.getOriginalResponse().getRequestId())
+        .isEqualTo("26ea36b5-c196-4806-a9a6-a686f0c6ad91");
 
     // verify that the history is sent correctly
     try (var requestInputStream = fileLoader.apply("messagesHistoryRequest.json")) {
@@ -310,7 +311,7 @@ void maskingPseudonymization() throws IOException {
         createMaskingConfig(DPIConfig.MethodEnum.PSEUDONYMIZATION, DPIEntities.PHONE);
 
     final var result = client.chatCompletion(prompt, config.withMaskingConfig(maskingConfig));
-    final var response = result.getData();
+    final var response = result.getOriginalResponse();
 
     assertThat(response).isNotNull();
     GenericModuleResult inputMasking = response.getModuleResults().getInputMasking();
@@ -412,4 +413,17 @@ void testErrorHandling() {
 
     softly.assertAll();
   }
+
+  @Test
+  void testEmptyChoicesResponse() {
+    stubFor(
+        post(urlPathEqualTo("/v2/inference/deployments/abcdef0123456789/completion"))
+            .willReturn(
+                aResponse()
+                    .withBodyFile("emptyChoicesResponse.json")
+                    .withHeader("Content-Type", "application/json")));
+    final var result = client.chatCompletion(prompt, config);
+
+    assertThat(result.getContent()).isEmpty();
+  }
 }

orchestration/src/test/resources/__files/emptyChoicesResponse.json

@@ -0,0 +1,35 @@
+{
+  "request_id": "26ea36b5-c196-4806-a9a6-a686f0c6ad91",
+  "module_results": {
+    "templating": [
+      {
+        "role": "user",
+        "content": "Reply with 'Orchestration Service is working!' in German"
+      }
+    ],
+    "llm": {
+      "id": "chatcmpl-9lzPV4kLrXjFckOp2yY454wksWBoj",
+      "object": "chat.completion",
+      "created": 1721224505,
+      "model": "gpt-35-turbo-16k",
+      "choices": [],
+      "usage": {
+        "completion_tokens": 7,
+        "prompt_tokens": 19,
+        "total_tokens": 26
+      }
+    }
+  },
+  "orchestration_result": {
+    "id": "chatcmpl-9lzPV4kLrXjFckOp2yY454wksWBoj",
+    "object": "chat.completion",
+    "created": 1721224505,
+    "model": "gpt-35-turbo-16k",
+    "choices": [],
+    "usage": {
+      "completion_tokens": 7,
+      "prompt_tokens": 19,
+      "total_tokens": 26
+    }
+  }
+}

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

@@ -1,9 +1,9 @@
 package com.sap.ai.sdk.app.controllers;
 
+import com.sap.ai.sdk.orchestration.OrchestrationChatResponse;
 import com.sap.ai.sdk.orchestration.OrchestrationClient;
 import com.sap.ai.sdk.orchestration.OrchestrationModuleConfig;
 import com.sap.ai.sdk.orchestration.OrchestrationPrompt;
-import com.sap.ai.sdk.orchestration.OrchestrationResponse;
 import com.sap.ai.sdk.orchestration.client.model.AzureContentSafety;
 import com.sap.ai.sdk.orchestration.client.model.AzureContentSafetyFilterConfig;
 import com.sap.ai.sdk.orchestration.client.model.AzureThreshold;
@@ -44,7 +44,7 @@ class OrchestrationController {
    */
   @GetMapping("/completion")
   @Nonnull
-  public OrchestrationResponse completion() {
+  public OrchestrationChatResponse completion() {
     final var prompt = new OrchestrationPrompt("Hello world! Why is this phrase so famous?");
 
     return client.chatCompletion(prompt, config);
@@ -57,7 +57,7 @@ public OrchestrationResponse completion() {
    */
   @GetMapping("/template")
   @Nonnull
-  public OrchestrationResponse template() {
+  public OrchestrationChatResponse template() {
     final var template =
         new ChatMessage()
             .role("user")
@@ -78,7 +78,7 @@ public OrchestrationResponse template() {
    */
   @GetMapping("/messagesHistory")
   @Nonnull
-  public OrchestrationResponse messagesHistory() {
+  public OrchestrationChatResponse messagesHistory() {
     final List<ChatMessage> messagesHistory =
         List.of(
             new ChatMessage().role("user").content("What is the capital of France?"),
@@ -98,7 +98,7 @@ public OrchestrationResponse messagesHistory() {
    */
   @GetMapping("/filter/{threshold}")
   @Nonnull
-  public OrchestrationResponse filter(
+  public OrchestrationChatResponse filter(
       @Nonnull @PathVariable("threshold") final AzureThreshold threshold) {
     final var prompt =
         new OrchestrationPrompt(
@@ -145,7 +145,7 @@ private static FilteringModuleConfig createAzureContentFilter(
    */
   @GetMapping("/maskingAnonymization")
   @Nonnull
-  public OrchestrationResponse maskingAnonymization() {
+  public OrchestrationChatResponse maskingAnonymization() {
     final var systemMessage =
         new ChatMessage()
             .role("system")
@@ -176,7 +176,7 @@ public OrchestrationResponse maskingAnonymization() {
    */
   @GetMapping("/maskingPseudonymization")
   @Nonnull
-  public OrchestrationResponse maskingPseudonymization() {
+  public OrchestrationChatResponse maskingPseudonymization() {
     final var systemMessage =
         new ChatMessage()
             .role("system")

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

@@ -33,7 +33,7 @@ void testCompletion() {
   @Test
   void testTemplate() {
     final var response = controller.template();
-    final var result = response.getData();
+    final var result = response.getOriginalResponse();
 
     assertThat(result.getRequestId()).isNotEmpty();
     assertThat(result.getModuleResults().getTemplating().get(0).getContent())
@@ -73,7 +73,7 @@ void testTemplate() {
   @Test
   void testLenientContentFilter() {
     var response = controller.filter(AzureThreshold.NUMBER_4);
-    var result = response.getData();
+    var result = response.getOriginalResponse();
     var llmChoice =
         ((LLMModuleResultSynchronous) result.getOrchestrationResult()).getChoices().get(0);
     assertThat(llmChoice.getFinishReason()).isEqualTo("stop");
@@ -93,7 +93,7 @@ void testStrictContentFilter() {
 
   @Test
   void testMessagesHistory() {
-    CompletionPostResponse result = controller.messagesHistory().getData();
+    CompletionPostResponse result = controller.messagesHistory().getOriginalResponse();
     final var choices = ((LLMModuleResultSynchronous) result.getOrchestrationResult()).getChoices();
     assertThat(choices.get(0).getMessage().getContent()).isNotEmpty();
   }
@@ -102,7 +102,7 @@ void testMessagesHistory() {
   @Test
   void testMaskingAnonymization() {
     var response = controller.maskingAnonymization();
-    var result = response.getData();
+    var result = response.getOriginalResponse();
     var llmChoice =
         ((LLMModuleResultSynchronous) result.getOrchestrationResult()).getChoices().get(0);
     assertThat(llmChoice.getFinishReason()).isEqualTo("stop");
@@ -122,7 +122,7 @@ void testMaskingAnonymization() {
   @Test
   void testMaskingPseudonymization() {
     var response = controller.maskingPseudonymization();
-    var result = response.getData();
+    var result = response.getOriginalResponse();
     var llmChoice =
         ((LLMModuleResultSynchronous) result.getOrchestrationResult()).getChoices().get(0);
     assertThat(llmChoice.getFinishReason()).isEqualTo("stop");