feat: Orchestration Make getLlmChoice public

Author: MatKuhr

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

@@ -62,12 +62,12 @@ public List<ChatMessage> getAllMessages() {
   }
 
   /**
-   * Get current choice.
+   * Get the LLM response. Useful for accessing the finish reason or further data like logprobs.
    *
-   * @return The current choice.
+   * @return The (first, in case of multiple) {@link LLMChoice}.
    */
   @Nonnull
-  private LLMChoice getCurrentChoice() {
+  public LLMChoice getCurrentChoice() {
     //    We expect choices to be defined and never empty.
     return ((LLMModuleResultSynchronous) originalResponse.getOrchestrationResult())
         .getChoices()

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

@@ -10,6 +10,7 @@
 import com.sap.ai.sdk.orchestration.Message;
 import com.sap.ai.sdk.orchestration.OrchestrationChatResponse;
 import com.sap.ai.sdk.orchestration.OrchestrationClient;
+import com.sap.ai.sdk.orchestration.OrchestrationClientException;
 import com.sap.ai.sdk.orchestration.OrchestrationModuleConfig;
 import com.sap.ai.sdk.orchestration.OrchestrationPrompt;
 import com.sap.ai.sdk.orchestration.SystemMessage;
@@ -19,13 +20,15 @@
 import java.util.List;
 import java.util.Map;
 import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /** Endpoints for the Orchestration service */
 @RestController
+@Slf4j
 @RequestMapping("/orchestration")
 class OrchestrationController {
   private final OrchestrationClient client = new OrchestrationClient();
@@ -42,7 +45,11 @@ class OrchestrationController {
   public OrchestrationChatResponse completion() {
     final var prompt = new OrchestrationPrompt("Hello world! Why is this phrase so famous?");
 
-    return client.chatCompletion(prompt, config);
+    final var result = client.chatCompletion(prompt, config);
+
+    log.info("Our trusty AI answered with: {}", result.getContent());
+
+    return result;
   }
 
   /**
@@ -106,7 +113,16 @@ public OrchestrationChatResponse filter(
     final var configWithFilter =
         config.withInputFiltering(filterConfig).withOutputFiltering(filterConfig);
 
-    return client.chatCompletion(prompt, configWithFilter);
+    final OrchestrationChatResponse result = client.chatCompletion(prompt, configWithFilter);
+    try {
+      // in case the output was filtered, calling .getContent() will throw
+      log.info("The following AI response passed the output filter: {}", result.getContent());
+    } catch (OrchestrationClientException e) {
+      log.info("The content filter blocked the output.");
+      // alternatively to calling .getContent(), you can also check the finish reason manually
+      log.info("Finish reason: {}", result.getCurrentChoice().getFinishReason());
+    }
+    return result;
   }
 
   /**

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

@@ -67,6 +67,7 @@ void testTemplate() {
     assertThat(choices.get(0).getMessage().getContent()).isNotEmpty();
     assertThat(choices.get(0).getMessage().getRole()).isEqualTo("assistant");
     assertThat(choices.get(0).getFinishReason()).isEqualTo("stop");
+    assertThat(result.getCurrentChoice()).isSameAs(choices.get(0));
     usage = result.getTokenUsage();
     assertThat(usage.getCompletionTokens()).isGreaterThan(1);
     assertThat(usage.getPromptTokens()).isGreaterThan(1);