Merge branch 'main' into spec-update/grounding/main

Author: Jonas-Isr

docs/release_notes.md

@@ -8,7 +8,7 @@
 
 ### 🔧 Compatibility Notes
 
--
+- The constructor of the `AssistantMessage` class now takes `List<MessageToolCall>` as input instead of `List<ResponseMessageToolCall>` (the generated class got renamed).
 
 ### ✨ New Functionality
 

orchestration/pom.xml

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

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

@@ -1,9 +1,13 @@
 package com.sap.ai.sdk.orchestration;
 
+import static com.sap.ai.sdk.orchestration.model.AssistantChatMessage.RoleEnum.ASSISTANT;
+
 import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.orchestration.model.AssistantChatMessage;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
-import com.sap.ai.sdk.orchestration.model.ResponseMessageToolCall;
-import com.sap.ai.sdk.orchestration.model.SingleChatMessage;
+import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
+import com.sap.ai.sdk.orchestration.model.MessageToolCall;
+import com.sap.ai.sdk.orchestration.model.TextContent;
 import java.util.List;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -27,7 +31,7 @@ public class AssistantMessage implements Message {
   MessageContent content;
 
   /** Tool call if there is any. */
-  @Nullable List<ResponseMessageToolCall> toolCalls;
+  @Nullable List<MessageToolCall> toolCalls;
 
   /**
    * Creates a new assistant message with the given single message.
@@ -39,12 +43,22 @@ public AssistantMessage(@Nonnull final String singleMessage) {
     toolCalls = null;
   }
 
+  /**
+   * Creates a new assistant message with the given single message.
+   *
+   * @param content the single message.
+   */
+  AssistantMessage(@Nonnull final MessageContent content) {
+    this.content = content;
+    toolCalls = null;
+  }
+
   /**
    * Creates a new assistant message with the given tool calls.
    *
    * @param toolCalls list of tool call objects
    */
-  public AssistantMessage(@Nonnull final List<ResponseMessageToolCall> toolCalls) {
+  public AssistantMessage(@Nonnull final List<MessageToolCall> toolCalls) {
     content = new MessageContent(List.of());
     this.toolCalls = toolCalls;
   }
@@ -53,11 +67,15 @@ public AssistantMessage(@Nonnull final List<ResponseMessageToolCall> toolCalls)
   @Override
   public ChatMessage createChatMessage() {
     if (toolCalls() != null) {
-      // content shouldn't be required for tool calls 🤷
-      val message = SingleChatMessage.create().role(role).content("");
-      message.setCustomField("tool_calls", toolCalls);
-      return message;
+      return AssistantChatMessage.create().role(ASSISTANT).toolCalls(toolCalls);
     }
-    return Message.super.createChatMessage();
+    val texts =
+        content.items().stream()
+            .filter(item -> item instanceof TextItem)
+            .map(item -> (TextItem) item)
+            .map(item -> TextContent.create().type(TextContent.TypeEnum.TEXT).text(item.text()))
+            .toList();
+
+    return AssistantChatMessage.create().role(ASSISTANT).content(ChatMessageContent.create(texts));
   }
 }

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

@@ -40,4 +40,28 @@ interface NoneTypeInfoMixin {}
         name = "text")
   })
   interface ResponseFormatSubTypesMixin {}
+
+  @JsonTypeInfo(
+      use = JsonTypeInfo.Id.NAME,
+      include = JsonTypeInfo.As.PROPERTY,
+      property = "role",
+      visible = true)
+  @JsonSubTypes({
+    @JsonSubTypes.Type(
+        value = com.sap.ai.sdk.orchestration.model.AssistantChatMessage.class,
+        name = "assistant"),
+    @JsonSubTypes.Type(
+        value = com.sap.ai.sdk.orchestration.model.DeveloperChatMessage.class,
+        name = "developer"),
+    @JsonSubTypes.Type(
+        value = com.sap.ai.sdk.orchestration.model.SystemChatMessage.class,
+        name = "system"),
+    @JsonSubTypes.Type(
+        value = com.sap.ai.sdk.orchestration.model.ToolChatMessage.class,
+        name = "tool"),
+    @JsonSubTypes.Type(
+        value = com.sap.ai.sdk.orchestration.model.UserChatMessage.class,
+        name = "user")
+  })
+  interface ChatMessageMixin {}
 }

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

@@ -2,13 +2,6 @@
 
 import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
-import com.sap.ai.sdk.orchestration.model.ImageContent;
-import com.sap.ai.sdk.orchestration.model.ImageContentImageUrl;
-import com.sap.ai.sdk.orchestration.model.MultiChatMessage;
-import com.sap.ai.sdk.orchestration.model.MultiChatMessageContent;
-import com.sap.ai.sdk.orchestration.model.SingleChatMessage;
-import com.sap.ai.sdk.orchestration.model.TextContent;
-import java.util.LinkedList;
 import java.util.List;
 import javax.annotation.Nonnull;
 
@@ -66,23 +59,7 @@ static SystemMessage system(@Nonnull final String message) {
    * @return the corresponding {@code ChatMessage} object.
    */
   @Nonnull
-  default ChatMessage createChatMessage() {
-    final var itemList = this.content().items();
-    if (itemList.size() == 1 && itemList.get(0) instanceof TextItem textItem) {
-      return SingleChatMessage.create().role(role()).content(textItem.text());
-    }
-    final var contentList = new LinkedList<MultiChatMessageContent>();
-    for (final ContentItem item : itemList) {
-      if (item instanceof TextItem textItem) {
-        contentList.add(TextContent.create().type(TextContent.TypeEnum.TEXT).text(textItem.text()));
-      } else if (item instanceof ImageItem imageItem) {
-        final var detail = imageItem.detailLevel().toString();
-        final var img = ImageContentImageUrl.create().url(imageItem.imageUrl()).detail(detail);
-        contentList.add(ImageContent.create().type(ImageContent.TypeEnum.IMAGE_URL).imageUrl(img));
-      }
-    }
-    return MultiChatMessage.create().role(role()).content(contentList);
-  }
+  ChatMessage createChatMessage();
 
   /**
    * Returns the role of the assistant.

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

@@ -1,10 +1,12 @@
 package com.sap.ai.sdk.orchestration;
 
-import com.sap.ai.sdk.orchestration.model.ImageContent;
-import com.sap.ai.sdk.orchestration.model.MultiChatMessageContent;
-import com.sap.ai.sdk.orchestration.model.TextContent;
+import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
+import com.sap.ai.sdk.orchestration.model.UserChatMessageContent;
+import com.sap.ai.sdk.orchestration.model.UserChatMessageContentItem;
+import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nonnull;
+import lombok.val;
 
 /**
  * Represents the content of a chat message.
@@ -14,23 +16,39 @@
  */
 public record MessageContent(@Nonnull List<ContentItem> items) {
   @Nonnull
-  static MessageContent fromMCMContentList(
-      @Nonnull final List<MultiChatMessageContent> mCMContentList) {
-    final var itemList =
-        mCMContentList.stream()
-            .map(
-                content -> {
-                  if (content instanceof TextContent text) {
-                    return new TextItem(text.getText());
-                  } else {
-                    final var imageUrl = ((ImageContent) content).getImageUrl();
-                    return (ContentItem)
-                        new ImageItem(
-                            imageUrl.getUrl(),
-                            ImageItem.DetailLevel.fromString(imageUrl.getDetail()));
-                  }
-                })
-            .toList();
-    return new MessageContent(itemList);
+  static MessageContent fromChatMessageContent(final ChatMessageContent chatMessageContent) {
+    if (chatMessageContent instanceof ChatMessageContent.InnerString innerString) {
+      return new MessageContent(List.of(new TextItem(innerString.value())));
+    } else if (chatMessageContent
+        instanceof ChatMessageContent.InnerTextContents innerTextContents) {
+      val texts =
+          innerTextContents.values().stream()
+              .map(textContent -> ((ContentItem) new TextItem(textContent.getText())))
+              .toList();
+      return new MessageContent(texts);
+    }
+    return new MessageContent(List.of());
+  }
+
+  @Nonnull
+  static MessageContent fromUserChatMessageContent(
+      final UserChatMessageContent chatMessageContent) {
+    if (chatMessageContent instanceof UserChatMessageContent.InnerString innerString) {
+      return new MessageContent(List.of(new TextItem(innerString.value())));
+    } else if (chatMessageContent
+        instanceof
+        final UserChatMessageContent.InnerUserChatMessageContentItems innerContentItems) {
+      val items = new ArrayList<ContentItem>();
+      for (val value : innerContentItems.values()) {
+        if (value.getType().equals(UserChatMessageContentItem.TypeEnum.TEXT)) {
+          items.add(new TextItem(value.getText()));
+        } else if (value.getType().equals(UserChatMessageContentItem.TypeEnum.IMAGE_URL)) {
+          val detailLevel = ImageItem.DetailLevel.fromString(value.getImageUrl().getDetail());
+          items.add(new ImageItem(value.getImageUrl().getUrl(), detailLevel));
+        }
+      }
+      return new MessageContent(items);
+    }
+    return new MessageContent(List.of());
   }
 }

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

@@ -2,18 +2,22 @@
 
 import static lombok.AccessLevel.PACKAGE;
 
+import com.sap.ai.sdk.orchestration.model.AssistantChatMessage;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
+import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
 import com.sap.ai.sdk.orchestration.model.CompletionPostResponse;
 import com.sap.ai.sdk.orchestration.model.LLMChoice;
 import com.sap.ai.sdk.orchestration.model.LLMModuleResultSynchronous;
-import com.sap.ai.sdk.orchestration.model.MultiChatMessage;
-import com.sap.ai.sdk.orchestration.model.SingleChatMessage;
+import com.sap.ai.sdk.orchestration.model.SystemChatMessage;
 import com.sap.ai.sdk.orchestration.model.TokenUsage;
+import com.sap.ai.sdk.orchestration.model.ToolChatMessage;
+import com.sap.ai.sdk.orchestration.model.UserChatMessage;
 import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nonnull;
 import lombok.RequiredArgsConstructor;
 import lombok.Value;
+import lombok.val;
 
 /** Orchestration chat completion output. */
 @Value
@@ -57,42 +61,40 @@ public TokenUsage getTokenUsage() {
    */
   @Nonnull
   public List<Message> getAllMessages() throws IllegalArgumentException {
-    final var messages = new ArrayList<Message>();
+    val messages = new ArrayList<Message>();
     for (final ChatMessage chatMessage : originalResponse.getModuleResults().getTemplating()) {
-      if (chatMessage instanceof SingleChatMessage simpleMsg) {
-        messages.add(chatMessageIntoMessage(simpleMsg));
-      } else if (chatMessage instanceof MultiChatMessage mCMessage) {
-        messages.add(chatMessageIntoMessage(mCMessage));
+      if (chatMessage instanceof AssistantChatMessage assistantChatMessage) {
+        val toolCalls = assistantChatMessage.getToolCalls();
+        if (!toolCalls.isEmpty()) {
+          messages.add(new AssistantMessage(toolCalls));
+        } else {
+          messages.add(
+              new AssistantMessage(
+                  MessageContent.fromChatMessageContent(assistantChatMessage.getContent())));
+        }
+      } else if (chatMessage instanceof SystemChatMessage systemChatMessage) {
+        messages.add(
+            new SystemMessage(
+                MessageContent.fromChatMessageContent(systemChatMessage.getContent())));
+      } else if (chatMessage instanceof UserChatMessage userChatMessage) {
+        messages.add(
+            new UserMessage(
+                MessageContent.fromUserChatMessageContent(userChatMessage.getContent())));
+      } else if (chatMessage instanceof ToolChatMessage toolChatMessage) {
+        messages.add(
+            new ToolMessage(
+                toolChatMessage.getToolCallId(),
+                ((ChatMessageContent.InnerString) toolChatMessage.getContent()).value()));
       } else {
         throw new IllegalArgumentException(
             "Messages of type " + chatMessage.getClass() + " are not supported by convenience API");
       }
     }
+
     messages.add(Message.assistant(getChoice().getMessage().getContent()));
     return messages;
   }
 
-  @Nonnull
-  private Message chatMessageIntoMessage(@Nonnull final SingleChatMessage simpleMsg) {
-    return switch (simpleMsg.getRole()) {
-      case "user" -> Message.user(simpleMsg.getContent());
-      case "assistant" -> Message.assistant(simpleMsg.getContent());
-      case "system" -> Message.system(simpleMsg.getContent());
-      default -> throw new IllegalStateException("Unexpected role: " + simpleMsg.getRole());
-    };
-  }
-
-  @Nonnull
-  private Message chatMessageIntoMessage(@Nonnull final MultiChatMessage mCMessage) {
-    return switch (mCMessage.getRole()) {
-      case "user" -> new UserMessage(MessageContent.fromMCMContentList(mCMessage.getContent()));
-      case "system" -> new SystemMessage(MessageContent.fromMCMContentList(mCMessage.getContent()));
-      default ->
-          throw new IllegalStateException(
-              "Unexpected role with complex message: " + mCMessage.getRole());
-    };
-  }
-
   /**
    * Get the LLM response. Useful for accessing the finish reason or further data like logprobs.
    *

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

@@ -42,16 +42,13 @@ public static ObjectMapper getOrchestrationObjectMapper() {
     jackson.addMixIn(
         ModuleResultsOutputUnmaskingInner.class,
         JacksonMixins.ModuleResultsOutputUnmaskingInnerMixIn.class);
+    jackson.addMixIn(ChatMessage.class, JacksonMixins.ChatMessageMixin.class);
 
     final var module =
         new SimpleModule()
-            .addDeserializer(
-                ChatMessage.class,
-                PolymorphicFallbackDeserializer.fromJsonSubTypes(ChatMessage.class))
             .addDeserializer(
                 TemplateResponseFormat.class,
                 PolymorphicFallbackDeserializer.fromJsonSubTypes(TemplateResponseFormat.class))
-            .setMixInAnnotation(ChatMessage.class, JacksonMixins.NoneTypeInfoMixin.class)
             .setMixInAnnotation(
                 TemplateResponseFormat.class, JacksonMixins.ResponseFormatSubTypesMixin.class);
     jackson.registerModule(module);

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

@@ -1,6 +1,12 @@
 package com.sap.ai.sdk.orchestration;
 
+import static com.sap.ai.sdk.orchestration.model.SystemChatMessage.RoleEnum.SYSTEM;
+
 import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.orchestration.model.ChatMessage;
+import com.sap.ai.sdk.orchestration.model.ChatMessageContent;
+import com.sap.ai.sdk.orchestration.model.SystemChatMessage;
+import com.sap.ai.sdk.orchestration.model.TextContent;
 import java.util.LinkedList;
 import java.util.List;
 import javax.annotation.Nonnull;
@@ -10,6 +16,7 @@
 import lombok.Value;
 import lombok.experimental.Accessors;
 import lombok.experimental.Tolerate;
+import lombok.val;
 
 /** Represents a chat message as 'system' to the orchestration service. */
 @Value
@@ -48,4 +55,16 @@ public SystemMessage withText(@Nonnull final String message) {
     contentItems.add(new TextItem(message));
     return new SystemMessage(new MessageContent(contentItems));
   }
+
+  @Nonnull
+  @Override
+  public ChatMessage createChatMessage() {
+    val texts =
+        content.items().stream()
+            .filter(item -> item instanceof TextItem)
+            .map(item -> (TextItem) item)
+            .map(item -> TextContent.create().type(TextContent.TypeEnum.TEXT).text(item.text()))
+            .toList();
+    return SystemChatMessage.create().role(SYSTEM).content(ChatMessageContent.create(texts));
+  }
 }