Merge branch 'main' into chore/cleanup

Author: MatKuhr

docs/guides/ORCHESTRATION_CHAT_COMPLETION.md

@@ -102,10 +102,7 @@ The LLM response is available as the first choice under the `result.getOrchestra
 Use a prepared template and execute requests with by passing only the input parameters:
 
 ```java
-var template =
-    ChatMessage.create()
-        .role("user")
-        .content("Reply with 'Orchestration Service is working!' in {{?language}}");
+var template = Message.user("Reply with 'Orchestration Service is working!' in {{?language}}");
 var templatingConfig = TemplatingModuleConfig.create().template(template);
 var configWithTemplate = config.withTemplateConfig(templatingConfig);
 
@@ -124,10 +121,10 @@ Include a message history to maintain context in the conversation:
 ```java
 var messagesHistory =
         List.of(
-                ChatMessage.create().role("user").content("What is the capital of France?"),
-                ChatMessage.create().role("assistant").content("The capital of France is Paris."));
+            Message.user("What is the capital of France?"),
+            Message.assistant("The capital of France is Paris."));
 var message =
-        ChatMessage.create().role("user").content("What is the typical food there?");
+    Message.user("What is the typical food there?");
 
 var prompt = new OrchestrationPrompt(message).messageHistory(messagesHistory);
 
@@ -175,12 +172,8 @@ var maskingConfig =
     DpiMasking.anonymization().withEntities(DPIEntities.PHONE, DPIEntities.PERSON);
 var configWithMasking = config.withMaskingConfig(maskingConfig);
 
-var systemMessage = ChatMessage.create()
-        .role("system")
-        .content("Please evaluate the following user feedback and judge if the sentiment is positive or negative.");
-var userMessage = ChatMessage.create()
-        .role("user")
-        .content("""
+var systemMessage = Message.system("Please evaluate the following user feedback and judge if the sentiment is positive or negative.");
+var userMessage = Message.user("""
                  I think the SDK is good, but could use some further enhancements.
                  My architect Alice and manager Bob pointed out that we need the grounding capabilities, which aren't supported yet.
                  """);

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

@@ -21,6 +21,13 @@
  *     .hate(AzureFilterThreshold.ALLOW_SAFE)
  *     .selfHarm(AzureFilterThreshold.ALLOW_SAFE_LOW);
  * }</pre>
+ *
+ * @link <a
+ *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
+ *     Core: Orchestration - Input Filtering</a>
+ * @link <a
+ *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
+ *     AI Core: Orchestration - Output Filtering</a>
  */
 @Setter
 @NoArgsConstructor

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

@@ -6,6 +6,13 @@
 /**
  * Interface representing convenience wrappers of serializable content filter that defines
  * thresholds for different content categories.
+ *
+ * @link <a
+ *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP AI
+ *     Core: Orchestration - Input Filtering</a>
+ * @link <a
+ *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
+ *     AI Core: Orchestration - Output Filtering</a>
  */
 public interface ContentFilter {
 

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

@@ -21,6 +21,9 @@
 /**
  * SAP Data Privacy Integration (DPI) can mask personally identifiable information using either
  * anonymization or pseudonymization.
+ *
+ * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
+ *     AI Core: Orchestration - Data Masking</a>
  */
 @Value
 @Getter(AccessLevel.PACKAGE)

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

@@ -3,7 +3,12 @@
 import com.sap.ai.sdk.orchestration.model.MaskingProviderConfig;
 import javax.annotation.Nonnull;
 
-/** Interface for masking configurations. */
+/**
+ * Interface for masking configurations.
+ *
+ * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP
+ *     AI Core: Orchestration - Data Masking</a>
+ */
 public interface MaskingProvider {
 
   /**

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

@@ -1,5 +1,6 @@
 package com.sap.ai.sdk.orchestration;
 
+import com.google.common.annotations.Beta;
 import com.sap.ai.sdk.orchestration.model.ChatMessage;
 import javax.annotation.Nonnull;
 
@@ -63,5 +64,6 @@ default ChatMessage createChatMessage() {
    * @return the content.
    */
   @Nonnull
+  @Beta
   String content();
 }

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

@@ -9,7 +9,6 @@
 import com.sap.ai.sdk.orchestration.model.TokenUsage;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
 import javax.annotation.Nonnull;
 import lombok.RequiredArgsConstructor;
 import lombok.Value;
@@ -54,10 +53,21 @@ public TokenUsage getTokenUsage() {
    * @return A list of all messages.
    */
   @Nonnull
-  public List<ChatMessage> getAllMessages() {
-    final var items = Objects.requireNonNull(originalResponse.getModuleResults().getTemplating());
-    final var messages = new ArrayList<>(items);
-    messages.add(getCurrentChoice().getMessage());
+  public List<Message> getAllMessages() {
+    final var messages = new ArrayList<Message>();
+
+    for (final ChatMessage chatMessage : originalResponse.getModuleResults().getTemplating()) {
+      final var message =
+          switch (chatMessage.getRole()) {
+            case "user" -> new UserMessage(chatMessage.getContent());
+            case "assistant" -> new AssistantMessage(chatMessage.getContent());
+            case "system" -> new SystemMessage(chatMessage.getContent());
+            default -> throw new IllegalStateException("Unexpected role: " + chatMessage.getRole());
+          };
+      messages.add(message);
+    }
+
+    messages.add(new AssistantMessage(getCurrentChoice().getMessage().getContent()));
     return messages;
   }
 

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

@@ -34,6 +34,10 @@
  *   <li>Input Content Filtering (Optional)
  *   <li>Output Content Filtering (Optional)
  * </ul>
+ *
+ * @link <a
+ *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration-workflow">
+ *     SAP AI Core: Orchestration - Orchestration Workflow</a>
  */
 @Value
 @With
@@ -42,24 +46,49 @@
 public class OrchestrationModuleConfig {
   /**
    * The configured language model settings. This configuration is required when executing requests.
+   *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
+   *     SAP AI Core: Orchestration - Model Configuration</a>
    */
   @Nullable LLMModuleConfig llmConfig;
 
   /**
    * A template to be populated with input parameters. Upon request execution, this template will be
    * enhanced with any messages and parameter values from {@link OrchestrationPrompt}.
+   *
+   * @link <a href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/templating">SAP
+   *     AI Core: Orchestration - Templating</a>
    */
   @Nullable TemplatingModuleConfig templateConfig;
 
-  /** A masking configuration to pseudonymous or anonymize sensitive data in the input. */
+  /**
+   * A masking configuration to pseudonymous or anonymize sensitive data in the input.
+   *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
+   *     Core: Orchestration - Data Masking</a>
+   */
   @Nullable MaskingModuleConfig maskingConfig;
 
-  /** A content filter to filter the prompt. */
+  /**
+   * A content filter to filter the prompt.
+   *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
+   *     AI Core: Orchestration - Input Filtering</a>
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
+   *     AI Core: Orchestration - Output Filtering</a>
+   */
   @Nullable FilteringModuleConfig filteringConfig;
 
   /**
    * Creates a new configuration with the given LLM configuration.
    *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/model-configuration">
+   *     SAP AI Core: Orchestration - Model Configuration</a>
    * @param aiModel The LLM configuration to use.
    * @return A new configuration with the given LLM configuration.
    */
@@ -72,6 +101,9 @@ public OrchestrationModuleConfig withLlmConfig(@Nonnull final OrchestrationAiMod
   /**
    * Creates a new configuration with the given Data Masking configuration.
    *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/data-masking">SAP AI
+   *     Core: Orchestration - Data Masking</a>
    * @param maskingProvider The Data Masking configuration to use.
    * @param maskingProviders Additional Data Masking configurations to use.
    * @return A new configuration with the given Data Masking configuration.
@@ -94,6 +126,9 @@ public OrchestrationModuleConfig withMaskingConfig(
    *
    * <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding input filters.
    *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering">SAP
+   *     AI Core: Orchestration - Input Filtering</a>
    * @param contentFilters one or more content filters to apply to the input.
    * @return a new {@code OrchestrationModuleConfig} instance with the specified input filters
    *     added.
@@ -125,6 +160,9 @@ public OrchestrationModuleConfig withInputFiltering(
    * <p>Preferred over {@link #withFilteringConfig(FilteringModuleConfig)} for adding output
    * filters.
    *
+   * @link <a
+   *     href="https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering">SAP
+   *     AI Core: Orchestration - Output Filtering</a>
    * @param contentFilters one or more content filters to apply to the output.
    * @return a new {@code OrchestrationModuleConfig} instance with the specified output filters
    *     added.

orchestration/src/main/java/com/sap/ai/sdk/orchestration/model/AzureContentSafety.java

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

orchestration/src/main/java/com/sap/ai/sdk/orchestration/model/AzureContentSafetyFilterConfig.java

@@ -2,7 +2,7 @@
  * Orchestration
  * Orchestration is an inference service which provides common additional capabilities for business AI scenarios, such as content filtering and data masking. At the core of the service is the LLM module which allows for an easy, harmonized access to the language models of gen AI hub. The service is designed to be modular and extensible, allowing for the addition of new modules in the future. Each module can be configured independently and at runtime, allowing for a high degree of flexibility in the orchestration of AI services.
  *
- * The version of the OpenAPI document: 0.29.3
+ * The version of the OpenAPI document: 0.36.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).