feat: [Orchestration] Spring AI integration

docs/release-notes/release_notes.md

@@ -14,7 +14,10 @@
 
 ### ✨ New Functionality
 
-- [Integrated the Orchestration client in Spring AI.](../guides/ORCHESTRATION_CHAT_COMPLETION.md#spring-ai-integration)
+- Orchestration supports images as input in newly introduced `MultiChatMessage`.
+- `MultiChatMessage` also allows for multiple content items (text or image) in one object.
+- Grounding input can be masked with `DPIConfig`.
+- [Integrate the Orchestration client in Spring AI.](../guides/ORCHESTRATION_CHAT_COMPLETION.md#spring-ai-integration)
 
 ### 📈 Improvements
 

orchestration/pom.xml

@@ -31,10 +31,10 @@
   </developers>
   <properties>
     <project.rootdir>${project.basedir}/../</project.rootdir>
-    <coverage.complexity>78%</coverage.complexity>
-    <coverage.line>91%</coverage.line>
+    <coverage.complexity>76%</coverage.complexity>
+    <coverage.line>90%</coverage.line>
     <coverage.instruction>91%</coverage.instruction>
-    <coverage.branch>70%</coverage.branch>
+    <coverage.branch>69%</coverage.branch>
     <coverage.method>70%</coverage.method>
     <coverage.class>100%</coverage.class>
   </properties>
@@ -57,6 +57,7 @@
     <dependency>
       <groupId>org.springframework.ai</groupId>
       <artifactId>spring-ai-core</artifactId>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>org.apache.httpcomponents.core5</groupId>

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

@@ -15,9 +15,9 @@
 import lombok.NoArgsConstructor;
 import lombok.val;
 
-/** Factory to create all data objects from an orchestration configuration. */
+/** Internal factory to create all data objects from an orchestration configuration. */
 @NoArgsConstructor(access = AccessLevel.NONE)
-final class ConfigToRequestTransformer {
+public final class ConfigToRequestTransformer {
   @Nonnull
   static CompletionPostRequest toCompletionPostRequest(
       @Nonnull final OrchestrationPrompt prompt, @Nonnull final OrchestrationModuleConfig config) {
@@ -59,8 +59,9 @@ static TemplatingModuleConfig toTemplateModuleConfig(
     return Template.create().template(messagesWithPrompt);
   }
 
+  /** Internal method to convert the convenience configuration to the data objec configuration. */
   @Nonnull
-  static ModuleConfigs toModuleConfigs(@Nonnull final OrchestrationModuleConfig config) {
+  public static ModuleConfigs toModuleConfigs(@Nonnull final OrchestrationModuleConfig config) {
     val llmConfig =
         Option.of(config.getLlmConfig())
             .getOrElseThrow(() -> new IllegalStateException("LLM config is required."));

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

@@ -1,24 +1,20 @@
 package com.sap.ai.sdk.orchestration;
 
-import static com.sap.ai.sdk.core.JacksonConfiguration.getDefaultObjectMapper;
+import static com.sap.ai.sdk.orchestration.OrchestrationJacksonConfiguration.getOrchestrationObjectMapper;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.core.DeploymentResolutionException;
 import com.sap.ai.sdk.core.common.ClientResponseHandler;
 import com.sap.ai.sdk.core.common.ClientStreamingHandler;
 import com.sap.ai.sdk.core.common.StreamedDelta;
-import com.sap.ai.sdk.orchestration.model.ChatMessagesInner;
 import com.sap.ai.sdk.orchestration.model.CompletionPostRequest;
 import com.sap.ai.sdk.orchestration.model.CompletionPostResponse;
-import com.sap.ai.sdk.orchestration.model.LLMModuleResult;
 import com.sap.ai.sdk.orchestration.model.ModuleConfigs;
-import com.sap.ai.sdk.orchestration.model.ModuleResultsOutputUnmaskingInner;
 import com.sap.ai.sdk.orchestration.model.OrchestrationConfig;
 import com.sap.cloud.sdk.cloudplatform.connectivity.ApacheHttpClient5Accessor;
 import com.sap.cloud.sdk.cloudplatform.connectivity.HttpDestination;
@@ -41,25 +37,7 @@
 public class OrchestrationClient {
   private static final String DEFAULT_SCENARIO = "orchestration";
 
-  static final ObjectMapper JACKSON;
-
-  static {
-    JACKSON = getDefaultObjectMapper();
-
-    // Add mix-ins
-    JACKSON.addMixIn(LLMModuleResult.class, JacksonMixins.LLMModuleResultMixIn.class);
-    JACKSON.addMixIn(
-        ModuleResultsOutputUnmaskingInner.class,
-        JacksonMixins.ModuleResultsOutputUnmaskingInnerMixIn.class);
-
-    final var module =
-        new SimpleModule()
-            .addDeserializer(
-                ChatMessagesInner.class,
-                PolymorphicFallbackDeserializer.fromJsonSubTypes(ChatMessagesInner.class))
-            .setMixInAnnotation(ChatMessagesInner.class, JacksonMixins.NoneTypeInfoMixin.class);
-    JACKSON.registerModule(module);
-  }
+  static final ObjectMapper JACKSON = getOrchestrationObjectMapper();
 
   @Nonnull private final Supplier<HttpDestination> destinationSupplier;
 

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

@@ -0,0 +1,49 @@
+package com.sap.ai.sdk.orchestration;
+
+import static com.sap.ai.sdk.core.JacksonConfiguration.getDefaultObjectMapper;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.orchestration.model.ChatMessagesInner;
+import com.sap.ai.sdk.orchestration.model.LLMModuleResult;
+import com.sap.ai.sdk.orchestration.model.ModuleResultsOutputUnmaskingInner;
+import javax.annotation.Nonnull;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.val;
+
+/** Internal utility class for getting a default object mapper with preset configuration. */
+@NoArgsConstructor(access = AccessLevel.NONE)
+public class OrchestrationJacksonConfiguration {
+
+  /**
+   * Default object mapper used for JSON de-/serialization. <b>Only intended for internal usage
+   * within this SDK</b>. Largely follows the defaults set by Spring.
+   *
+   * @return A new object mapper with the default configuration.
+   * @see <a
+   *     href="https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.html">Jackson2ObjectMapperBuilder</a>
+   */
+  @Nonnull
+  @Beta
+  public static ObjectMapper getOrchestrationObjectMapper() {
+
+    val jackson = getDefaultObjectMapper();
+
+    // Add mix-ins
+    jackson.addMixIn(LLMModuleResult.class, JacksonMixins.LLMModuleResultMixIn.class);
+    jackson.addMixIn(
+        ModuleResultsOutputUnmaskingInner.class,
+        JacksonMixins.ModuleResultsOutputUnmaskingInnerMixIn.class);
+
+    final var module =
+        new SimpleModule()
+            .addDeserializer(
+                ChatMessagesInner.class,
+                PolymorphicFallbackDeserializer.fromJsonSubTypes(ChatMessagesInner.class))
+            .setMixInAnnotation(ChatMessagesInner.class, JacksonMixins.NoneTypeInfoMixin.class);
+    jackson.registerModule(module);
+    return jackson;
+  }
+}

orchestration/src/main/java/com/sap/ai/sdk/orchestration/spring/OrchestrationChatModel.java

@@ -1,5 +1,6 @@
 package com.sap.ai.sdk.orchestration.spring;
 
+import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.orchestration.AssistantMessage;
 import com.sap.ai.sdk.orchestration.OrchestrationClient;
 import com.sap.ai.sdk.orchestration.OrchestrationPrompt;
@@ -17,13 +18,22 @@
 import org.springframework.ai.chat.model.ChatResponse;
 import org.springframework.ai.chat.prompt.Prompt;
 
-/** Spring AI integration for the orchestration service. */
+/**
+ * Spring AI integration for the orchestration service.
+ *
+ * @since 1.2.0
+ */
+@Beta
 @Slf4j
 @RequiredArgsConstructor
 public class OrchestrationChatModel implements ChatModel {
   @Nonnull private OrchestrationClient client;
 
-  /** Default constructor. */
+  /**
+   * Default constructor.
+   *
+   * @since 1.2.0
+   */
   public OrchestrationChatModel() {
     this.client = new OrchestrationClient();
   }
@@ -32,12 +42,11 @@ public OrchestrationChatModel() {
   @Override
   public ChatResponse call(@Nonnull final Prompt prompt) {
 
-    if (prompt.getOptions() != null
-        && prompt.getOptions() instanceof OrchestrationChatOptions options) {
+    if (prompt.getOptions() instanceof OrchestrationChatOptions options) {
 
       val orchestrationPrompt = toOrchestrationPrompt(prompt);
       val response = client.chatCompletion(orchestrationPrompt, options.getConfig());
-      return OrchestrationChatResponse.fromOrchestrationResponse(response.getOriginalResponse());
+      return new OrchestrationSpringChatResponse(response);
     }
     throw new IllegalArgumentException(
         "Please add OrchestrationChatOptions to the Prompt: new Prompt(\"message\", new OrchestrationChatOptions(config))");
@@ -49,8 +58,6 @@ private OrchestrationPrompt toOrchestrationPrompt(@Nonnull final Prompt prompt)
     return new OrchestrationPrompt(Map.of(), messages);
   }
 
-  // endregion
-
   @Nonnull
   private static com.sap.ai.sdk.orchestration.Message[] toOrchestrationMessages(
       @Nonnull final List<Message> messages) {