fix: [Orchestration] Template Chat Message Type (#449)

* fix: [Orchestration] Template Chat Message Type

* Fix .createChatMessage()

* better deprecation

* green

* release notes

* Formatting

* release notes

* review

---------

Co-authored-by: Jonas Israel <[email protected]>
Co-authored-by: SAP Cloud SDK Bot <[email protected]>

Author: 3 people

docs/release_notes.md

@@ -18,6 +18,7 @@
   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.
 
 ### ✨ New Functionality
 

orchestration/pom.xml

@@ -31,10 +31,10 @@
   </developers>
   <properties>
     <project.rootdir>${project.basedir}/../</project.rootdir>
-    <coverage.complexity>84%</coverage.complexity>
+    <coverage.complexity>83%</coverage.complexity>
     <coverage.line>94%</coverage.line>
     <coverage.instruction>95%</coverage.instruction>
-    <coverage.branch>79%</coverage.branch>
+    <coverage.branch>78%</coverage.branch>
     <coverage.method>94%</coverage.method>
     <coverage.class>100%</coverage.class>
   </properties>

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/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);
   }
 }

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

@@ -413,7 +413,11 @@ void messagesHistory() throws IOException {
     final List<Message> messagesHistory =
         List.of(
             new UserMessage("What is the capital of France?"),
-            new AssistantMessage("The capital of France is Paris."));
+            new AssistantMessage(
+                new MessageContent(
+                    List.of(
+                        new TextItem("The capital of France is Paris."),
+                        new TextItem("Paris is known for its art, fashion, and culture.")))));
     final var message = new UserMessage("What is the typical food there?");
 
     prompt = new OrchestrationPrompt(message).messageHistory(messagesHistory);
@@ -565,10 +569,7 @@ void testExecuteRequestFromJson() {
         {
           "messages_history": [{
             "role" : "user",
-            "content" : [ {
-              "type" : "text",
-              "text" : "Hello World!"
-            } ]
+            "content" : "Hello World!"
           }],
           "input_params": {
             "foo" : "bar"

orchestration/src/test/resources/chatMemory.json

@@ -10,25 +10,16 @@
         "template": [
           {
             "role": "user",
-            "content": [ {
-              "type" : "text",
-              "text" : "What is the capital of France?"
-            } ]
+            "content": "What is the capital of France?"
           },
           {
             "role": "assistant",
-            "content" : [ {
-              "type" : "text",
-              "text" : "Le service d'orchestration fonctionne!"
-            } ],
+            "content" : "Le service d'orchestration fonctionne!",
             "tool_calls" : [ ]
           },
           {
             "role": "user",
-            "content": [ {
-              "type" : "text",
-              "text" : "And what is the typical food there?"
-            } ]
+            "content": "And what is the typical food there?"
           }
         ],
         "defaults": {},

orchestration/src/test/resources/filteringLooseRequest.json

@@ -17,10 +17,7 @@
         "template": [
           {
             "role": "user",
-            "content": [ {
-              "type" : "text",
-              "text" : "Hello World! Why is this phrase so famous?"
-            } ]
+            "content": "Hello World! Why is this phrase so famous?"
           }
         ],
         "defaults" : { },