Merge branch 'main' into spec-update/orchestration/fix/streaming-response-type

# Conflicts:
#	docs/release_notes.md
#	orchestration/pom.xml
#	orchestration/src/main/java/com/sap/ai/sdk/orchestration/JacksonMixins.java
#	sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/OrchestrationTest.java

Author: CharlesDuboisSAP

.github/workflows/e2e-test.yaml

@@ -39,9 +39,25 @@ jobs:
           mvn $MVN_ARGS
 
       - name: "Run tests"
+        id: run_tests
         run: |
           MVN_ARGS="${{ env.MVN_MULTI_THREADED_ARGS }} surefire:test -pl :spring-app -DskipTests=false"
-          mvn $MVN_ARGS "-Daicore.landscape=${{ matrix.environment }}"
+          mvn $MVN_ARGS "-Daicore.landscape=${{ matrix.environment }}" | tee mvn_output.log # tee writes to both the console and a file
+
+          awk '/Results:/, /----/' mvn_output.log > test_error.log || true # true ensures the step doesn't fail if no match is found.
+          ERROR_MSG=$(cat test_error.log | tail +4 | head -n -4 | awk '{gsub(/"/, "\\\""); printf "%s\\n", $0}') # Slack formatting
+          echo "$ERROR_MSG"
+          echo "error_message=$ERROR_MSG" >> $GITHUB_OUTPUT
+
+          if grep -q "BUILD FAILURE" mvn_output.log; then
+            echo "Maven build failed."
+            exit 1
+          elif grep -q "BUILD SUCCESS" mvn_output.log; then
+            echo "Maven build succeeded."
+          else
+            echo "Maven build status unknown."
+            exit 1
+          fi
         env:
           # See "End-to-end test application instructions" on the README.md to update the secret
           AICORE_SERVICE_KEY: ${{ secrets[matrix.secret-name] }}
@@ -74,7 +90,12 @@ jobs:
           webhook: ${{ secrets.SLACK_WEBHOOK }}
           webhook-type: incoming-webhook
           payload: |
-            {
-              "text": "⚠️ End-to-end tests failed! 😬 Please inspect & fix by clicking <https://github.com/SAP/ai-sdk-java/actions/runs/${{ github.run_id }}|here>"
-            }
-
+            blocks:
+              - type: "section"
+                text:
+                    type: "mrkdwn"
+                    text: "⚠️ End-to-end tests failed! 😬 Please inspect & fix by clicking <https://github.com/SAP/ai-sdk-java/actions/runs/${{ github.run_id }}|here>"
+              - type: "section"
+                text:
+                  type: "plain_text"
+                  text: "${{ steps.run_tests.outputs.error_message }}"

docs/release_notes.md

@@ -18,10 +18,12 @@
   Interfaces with only one implementation were reduced.
   As a result, the accessors for fields `OrchestrationModuleConfig.inputTranslationConfig` and `OrchestrationModuleConfig.outputTranslationConfig` now handle the implementing class explicitly.
   The same applies to helper methods `DpiMasking#createConfig()` and `MaskingProvider#createConfig()`.
+- [Orchestration] `OrchestrationTemplate.withTemplate()` has been deprecated. Please use `OrchestrationTemplate.withTemplateMessages()` instead.
 - [Orchestration] The method `createConfig()` is removed from `ContentFilter`, `AzureContentFilter` and `LlamaGuardFilter` and is replaced by `createInputFilterConfig()` and `createOutputFilterConfig()`.
 
 ### ✨ New Functionality
 
+- [Orchestration] Added support for [transforming a JSON output into an entity](https://sap.github.io/ai-sdk/docs/java/orchestration/chat-completion#json_schema)
 - [Orchestration] Added `AzureContentFilter#promptShield()` available for input filtering.
 
 ### 📈 Improvements
@@ -30,4 +32,4 @@
 
 ### 🐛 Fixed Issues
 
--
+- [Orchestration] Resolved duplicate JSON property issue, enabling Anthropic Claude chat completions.

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

@@ -66,9 +66,14 @@ public AssistantMessage(@Nonnull final List<MessageToolCall> toolCalls) {
   @Nonnull
   @Override
   public ChatMessage createChatMessage() {
-    if (toolCalls() != null) {
+    if (toolCalls != null) {
       return AssistantChatMessage.create().role(ASSISTANT).toolCalls(toolCalls);
     }
+    if (content.items().size() == 1 && content.items().get(0) instanceof TextItem textItem) {
+      return AssistantChatMessage.create()
+          .role(ASSISTANT)
+          .content(ChatMessageContent.create(textItem.text()));
+    }
     val texts =
         content.items().stream()
             .filter(item -> item instanceof TextItem)

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

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.sap.ai.sdk.orchestration.model.LLMModuleResult;
 import lombok.AccessLevel;
@@ -14,12 +15,9 @@ final class JacksonMixins {
   @JsonDeserialize(as = LLMModuleResult.class)
   interface LLMModuleResultMixIn {}
 
-  @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
-  interface NoneTypeInfoMixin {}
-
   @JsonTypeInfo(
       use = JsonTypeInfo.Id.NAME,
-      include = JsonTypeInfo.As.PROPERTY,
+      include = As.EXISTING_PROPERTY,
       property = "type",
       visible = true)
   @JsonSubTypes({
@@ -37,7 +35,7 @@ interface ResponseFormatSubTypesMixin {}
 
   @JsonTypeInfo(
       use = JsonTypeInfo.Id.NAME,
-      include = JsonTypeInfo.As.PROPERTY,
+      include = As.EXISTING_PROPERTY,
       property = "role",
       visible = true)
   @JsonSubTypes({

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

@@ -2,6 +2,9 @@
 
 import static lombok.AccessLevel.PACKAGE;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.exc.InvalidDefinitionException;
 import com.sap.ai.sdk.orchestration.model.AssistantChatMessage;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
 import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
@@ -104,4 +107,47 @@ public LLMChoice getChoice() {
     //    We expect choices to be defined and never empty.
     return originalResponse.getOrchestrationResult().getChoices().get(0);
   }
+
+  /**
+   * Transform a JSON response into an entity of the given type.
+   *
+   * <p>This is possible on a request with a {@link OrchestrationTemplate#withJsonSchemaResponse}
+   * configured into {@link OrchestrationModuleConfig#withTemplateConfig}.
+   *
+   * @param type the class type to deserialize the JSON content into.
+   * @return the deserialized entity of type T.
+   * @param <T> the type of the entity to deserialize to.
+   * @throws OrchestrationClientException if the model refused to answer the question or if the
+   *     content
+   */
+  @Nonnull
+  public <T> T asEntity(@Nonnull final Class<T> type) throws OrchestrationClientException {
+    final String refusal =
+        ((LLMModuleResultSynchronous) getOriginalResponse().getOrchestrationResult())
+            .getChoices()
+            .get(0)
+            .getMessage()
+            .getRefusal();
+    if (refusal != null) {
+      throw new OrchestrationClientException(
+          "The model refused to answer the question: " + refusal);
+    }
+    try {
+      return new ObjectMapper().readValue(getContent(), type);
+    } catch (InvalidDefinitionException e) {
+      throw new OrchestrationClientException(
+          "Failed to deserialize the JSON content. Please make sure to use the correct class and that the class has a no-args constructor or is static: "
+              + e.getMessage()
+              + "\nJSON content: "
+              + getContent(),
+          e);
+    } catch (JsonProcessingException e) {
+      throw new OrchestrationClientException(
+          "Failed to deserialize the JSON content. Please configure an OrchestrationTemplate with format set to JSON schema into your OrchestrationModuleConfig: "
+              + e.getMessage()
+              + "\nJSON content: "
+              + getContent(),
+          e);
+    }
+  }
 }

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

@@ -19,6 +19,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import lombok.AccessLevel;
@@ -41,8 +42,11 @@
 @NoArgsConstructor(force = true, access = AccessLevel.PACKAGE)
 @Beta
 public class OrchestrationTemplate extends TemplateConfig {
+
+  /** Please use {@link #withMessages(Message...)} instead. */
   @JsonProperty("template")
   @Nullable
+  @With(onMethod_ = {@Deprecated})
   List<ChatMessage> template;
 
   @JsonProperty("defaults")
@@ -58,6 +62,17 @@ public class OrchestrationTemplate extends TemplateConfig {
   @Nullable
   List<ChatCompletionTool> tools;
 
+  /**
+   * Create a new template with the given messages.
+   *
+   * @param messages The messages to use in the template.
+   * @return The updated template.
+   */
+  @Nonnull
+  public OrchestrationTemplate withMessages(@Nonnull final Message... messages) {
+    return this.withTemplate(Stream.of(messages).map(Message::createChatMessage).toList());
+  }
+
   /**
    * Create a low-level representation of the template.
    *

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

@@ -59,6 +59,11 @@ public SystemMessage withText(@Nonnull final String message) {
   @Nonnull
   @Override
   public ChatMessage createChatMessage() {
+    if (content.items().size() == 1 && content.items().get(0) instanceof TextItem textItem) {
+      return SystemChatMessage.create()
+          .role(SYSTEM)
+          .content(ChatMessageContent.create(textItem.text()));
+    }
     val texts =
         content.items().stream()
             .filter(item -> item instanceof TextItem)

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

@@ -93,7 +93,12 @@ public UserMessage withImage(@Nonnull final String imageUrl) {
   public ChatMessage createChatMessage() {
     final var contentList = new LinkedList<UserChatMessageContentItem>();
 
-    for (final ContentItem item : this.content().items()) {
+    if (content.items().size() == 1 && content.items().get(0) instanceof TextItem textItem) {
+      return UserChatMessage.create()
+          .content(UserChatMessageContent.create(textItem.text()))
+          .role(USER);
+    }
+    for (final ContentItem item : content.items()) {
       if (item instanceof TextItem textItem) {
         contentList.add(UserChatMessageContentItem.create().type(TEXT).text(textItem.text()));
       } else if (item instanceof ImageItem imageItem) {

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

@@ -4,15 +4,14 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.sap.ai.sdk.orchestration.model.ChatCompletionTool;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
-import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
 import com.sap.ai.sdk.orchestration.model.FunctionObject;
 import com.sap.ai.sdk.orchestration.model.ResponseFormatJsonObject;
 import com.sap.ai.sdk.orchestration.model.ResponseFormatJsonSchema;
 import com.sap.ai.sdk.orchestration.model.ResponseFormatJsonSchemaJsonSchema;
-import com.sap.ai.sdk.orchestration.model.SystemChatMessage;
-import com.sap.ai.sdk.orchestration.model.SystemChatMessage.RoleEnum;
 import com.sap.ai.sdk.orchestration.model.Template;
 import com.sap.ai.sdk.orchestration.model.TemplateRef;
 import com.sap.ai.sdk.orchestration.model.TemplateRefByID;
@@ -129,7 +128,8 @@ void testConfigWithResponseSchema() {
 
   @Test
   void testTemplateConstruction() {
-    List<ChatMessage> templateMessages =
+    Message templateMessages = Message.user("message");
+    List<ChatMessage> templateMessagesLowLevel =
         List.of(
             UserChatMessage.create().content(UserChatMessageContent.create("message")).role(USER));
     var defaults = Map.of("key", "value");
@@ -140,14 +140,14 @@ void testTemplateConstruction() {
                 .function(FunctionObject.create().name("func")));
     var template =
         TemplateConfig.create()
-            .withTemplate(templateMessages)
+            .withMessages(templateMessages)
             .withDefaults(defaults)
             .withTools(tools)
             .withJsonResponse();
 
     var templateLowLevel =
         Template.create()
-            .template(templateMessages)
+            .template(templateMessagesLowLevel)
             .defaults(defaults)
             .responseFormat(
                 ResponseFormatJsonObject.create()
@@ -206,15 +206,9 @@ void testTemplateFromLocalFileWithJsonSchemaAndTools() throws IOException {
             false);
     var expectedTemplateWithJsonSchemaTools =
         OrchestrationTemplate.create()
-            .withTemplate(
-                List.of(
-                    SystemChatMessage.create()
-                        .role(RoleEnum.SYSTEM)
-                        .content(ChatMessageContent.create("You are a language translator.")),
-                    UserChatMessage.create()
-                        .content(
-                            UserChatMessageContent.create("Whats {{ ?word }} in {{ ?language }}?"))
-                        .role(USER)))
+            .withMessages(
+                Message.system("You are a language translator."),
+                Message.user("Whats {{ ?word }} in {{ ?language }}?"))
             .withDefaults(Map.of("word", "apple"))
             .withJsonSchemaResponse(
                 ResponseJsonSchema.fromMap(schema, "translation-schema")
@@ -241,7 +235,12 @@ void testTemplateFromLocalFileWithJsonSchemaAndTools() throws IOException {
                                             "wordToTranslate", Map.of("type", "string"))))
                                 .description("Translate a word.")
                                 .strict(true))));
-    assertThat(templateWithJsonSchemaTools).isEqualTo(expectedTemplateWithJsonSchemaTools);
+
+    var jackson = new ObjectMapper();
+    JsonNode template = jackson.readTree(jackson.writeValueAsString(templateWithJsonSchemaTools));
+    JsonNode expectedTemplate =
+        jackson.readTree(jackson.writeValueAsString(expectedTemplateWithJsonSchemaTools));
+    assertThat(template).isEqualTo(expectedTemplate);
   }
 
   @Test
@@ -267,17 +266,16 @@ void testTemplateFromLocalFileWithJsonObject() throws IOException {
     var templateWithJsonObject = TemplateConfig.create().fromYaml(promptTemplateWithJsonObject);
     var expectedTemplateWithJsonObject =
         OrchestrationTemplate.create()
-            .withTemplate(
-                List.of(
-                    SystemChatMessage.create()
-                        .role(RoleEnum.SYSTEM)
-                        .content(ChatMessageContent.create("You are a language translator.")),
-                    UserChatMessage.create()
-                        .content(
-                            UserChatMessageContent.create("Whats {{ ?word }} in {{ ?language }}?"))
-                        .role(USER)))
+            .withMessages(
+                Message.system("You are a language translator."),
+                Message.user("Whats {{ ?word }} in {{ ?language }}?"))
             .withDefaults(Map.of("word", "apple"))
             .withJsonResponse();
-    assertThat(templateWithJsonObject).isEqualTo(expectedTemplateWithJsonObject);
+
+    var jackson = new ObjectMapper();
+    JsonNode template = jackson.readTree(jackson.writeValueAsString(templateWithJsonObject));
+    JsonNode expectedTemplate =
+        jackson.readTree(jackson.writeValueAsString(expectedTemplateWithJsonObject));
+    assertThat(template).isEqualTo(expectedTemplate);
   }
 }