Set filters conveniently

- Reuse the safety enum values
- Carry the immutability characteristic
- Disallow setting empty filter

Author: rpanackal

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

@@ -1,9 +1,15 @@
 package com.sap.ai.sdk.orchestration;
 
+import com.sap.ai.sdk.orchestration.client.model.AzureContentSafety;
+import com.sap.ai.sdk.orchestration.client.model.AzureContentSafetyFilterConfig;
 import com.sap.ai.sdk.orchestration.client.model.FilteringModuleConfig;
+import com.sap.ai.sdk.orchestration.client.model.InputFilteringConfig;
 import com.sap.ai.sdk.orchestration.client.model.LLMModuleConfig;
 import com.sap.ai.sdk.orchestration.client.model.MaskingModuleConfig;
+import com.sap.ai.sdk.orchestration.client.model.OutputFilteringConfig;
 import com.sap.ai.sdk.orchestration.client.model.TemplatingModuleConfig;
+import java.util.List;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
@@ -28,24 +34,57 @@
  * </ul>
  */
 @Value
-@With
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 @NoArgsConstructor(force = true)
 public class OrchestrationModuleConfig {
   /**
    * The configured language model settings. This configuration is required when executing requests.
    */
-  @Nullable LLMModuleConfig llmConfig;
+  @With @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}.
    */
-  @Nullable TemplatingModuleConfig templateConfig;
+  @With @Nullable TemplatingModuleConfig templateConfig;
 
   /** A masking configuration to pseudonymous or anonymize sensitive data in the input. */
-  @Nullable MaskingModuleConfig maskingConfig;
+  @With @Nullable MaskingModuleConfig maskingConfig;
 
   /** A content filter to filter the prompt. */
-  @Nullable FilteringModuleConfig filteringConfig;
+  @With(AccessLevel.PRIVATE)
+  @Nullable
+  FilteringModuleConfig filteringConfig;
+
+  @Nonnull
+  public OrchestrationModuleConfig withInputFiltering(AzureContentSafety contentFilter) {
+    var azureFilter =
+        new AzureContentSafetyFilterConfig()
+            .type(AzureContentSafetyFilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
+            .config(contentFilter);
+    var inputFilters = new InputFilteringConfig().filters(List.of(azureFilter));
+
+    var newFilteringConfig =
+        new FilteringModuleConfig()
+            .input(inputFilters)
+            .output(this.filteringConfig != null ? this.filteringConfig.getOutput() : null);
+
+    return this.withFilteringConfig(newFilteringConfig);
+  }
+
+  @Nonnull
+  public OrchestrationModuleConfig withOutputFiltering(AzureContentSafety safety) {
+    var filter =
+        new AzureContentSafetyFilterConfig()
+            .type(AzureContentSafetyFilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
+            .config(safety);
+    var outputFilteringConfig = new OutputFilteringConfig().filters(List.of(filter));
+
+    var newFilteringConfig =
+        new FilteringModuleConfig()
+            .output(outputFilteringConfig)
+            .input(this.filteringConfig != null ? this.filteringConfig.getInput() : null);
+
+    return this.withFilteringConfig(newFilteringConfig);
+  }
 }

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

@@ -29,20 +29,15 @@
 import com.github.tomakehurst.wiremock.stubbing.Scenario;
 import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.orchestration.client.model.AzureContentSafety;
-import com.sap.ai.sdk.orchestration.client.model.AzureContentSafetyFilterConfig;
-import com.sap.ai.sdk.orchestration.client.model.AzureThreshold;
 import com.sap.ai.sdk.orchestration.client.model.ChatMessage;
 import com.sap.ai.sdk.orchestration.client.model.CompletionPostRequest;
 import com.sap.ai.sdk.orchestration.client.model.DPIConfig;
 import com.sap.ai.sdk.orchestration.client.model.DPIEntities;
 import com.sap.ai.sdk.orchestration.client.model.DPIEntityConfig;
-import com.sap.ai.sdk.orchestration.client.model.FilteringModuleConfig;
 import com.sap.ai.sdk.orchestration.client.model.GenericModuleResult;
-import com.sap.ai.sdk.orchestration.client.model.InputFilteringConfig;
 import com.sap.ai.sdk.orchestration.client.model.LLMModuleConfig;
 import com.sap.ai.sdk.orchestration.client.model.LLMModuleResultSynchronous;
 import com.sap.ai.sdk.orchestration.client.model.MaskingModuleConfig;
-import com.sap.ai.sdk.orchestration.client.model.OutputFilteringConfig;
 import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
 import java.io.IOException;
 import java.io.InputStream;
@@ -217,9 +212,14 @@ void filteringLoose() throws IOException {
                     .withBodyFile("filteringLooseResponse.json")
                     .withHeader("Content-Type", "application/json")));
 
-    final var filter = createAzureContentFilter(NUMBER_4);
+    final var filter =
+        new AzureContentSafety()
+            .hate(NUMBER_4)
+            .selfHarm(NUMBER_4)
+            .sexual(NUMBER_4)
+            .violence(NUMBER_4);
 
-    client.chatCompletion(prompt, config.withFilteringConfig(filter));
+    client.chatCompletion(prompt, config.withInputFiltering(filter).withOutputFiltering(filter));
     // the result is asserted in the verify step below
 
     // verify that null fields are absent from the sent request
@@ -240,33 +240,21 @@ void filteringStrict() {
         post(urlPathEqualTo("/v2/inference/deployments/abcdef0123456789/completion"))
             .willReturn(jsonResponse(response, SC_BAD_REQUEST)));
 
-    final var filter = createAzureContentFilter(NUMBER_0);
+    final var filter =
+        new AzureContentSafety()
+            .hate(NUMBER_0)
+            .selfHarm(NUMBER_0)
+            .sexual(NUMBER_0)
+            .violence(NUMBER_0);
 
-    final var configWithFilter = config.withFilteringConfig(filter);
+    final var configWithFilter = config.withInputFiltering(filter).withOutputFiltering(filter);
 
     assertThatThrownBy(() -> client.chatCompletion(prompt, configWithFilter))
         .isInstanceOf(OrchestrationClientException.class)
         .hasMessage(
             "Request to orchestration service failed with status 400 Bad Request and error message: 'Content filtered due to Safety violations. Please modify the prompt and try again.'");
   }
 
-  private static FilteringModuleConfig createAzureContentFilter(
-      @Nonnull final AzureThreshold threshold) {
-    final var filter =
-        new AzureContentSafetyFilterConfig()
-            .type(AzureContentSafetyFilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
-            .config(
-                new AzureContentSafety()
-                    .hate(threshold)
-                    .selfHarm(threshold)
-                    .sexual(threshold)
-                    .violence(threshold));
-
-    return new FilteringModuleConfig()
-        .input(new InputFilteringConfig().filters(List.of(filter)))
-        .output(new OutputFilteringConfig().filters(List.of(filter)));
-  }
-
   @Test
   void messagesHistory() throws IOException {
     stubFor(

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/OrchestrationController.java

@@ -4,18 +4,14 @@
 import com.sap.ai.sdk.orchestration.OrchestrationModuleConfig;
 import com.sap.ai.sdk.orchestration.OrchestrationPrompt;
 import com.sap.ai.sdk.orchestration.client.model.AzureContentSafety;
-import com.sap.ai.sdk.orchestration.client.model.AzureContentSafetyFilterConfig;
 import com.sap.ai.sdk.orchestration.client.model.AzureThreshold;
 import com.sap.ai.sdk.orchestration.client.model.ChatMessage;
 import com.sap.ai.sdk.orchestration.client.model.CompletionPostResponse;
 import com.sap.ai.sdk.orchestration.client.model.DPIConfig;
 import com.sap.ai.sdk.orchestration.client.model.DPIEntities;
 import com.sap.ai.sdk.orchestration.client.model.DPIEntityConfig;
-import com.sap.ai.sdk.orchestration.client.model.FilteringModuleConfig;
-import com.sap.ai.sdk.orchestration.client.model.InputFilteringConfig;
 import com.sap.ai.sdk.orchestration.client.model.LLMModuleConfig;
 import com.sap.ai.sdk.orchestration.client.model.MaskingModuleConfig;
-import com.sap.ai.sdk.orchestration.client.model.OutputFilteringConfig;
 import com.sap.ai.sdk.orchestration.client.model.Template;
 import java.util.Arrays;
 import java.util.List;
@@ -107,34 +103,18 @@ public CompletionPostResponse filter(
 
             ```DISCLAIMER: The area surrounding the apartment is known for prostitutes and gang violence including armed conflicts, gun violence is frequent.
             """);
-    final var filterConfig = createAzureContentFilter(threshold);
-    final var configWithFilter = config.withFilteringConfig(filterConfig);
+    final var filterConfig =
+        new AzureContentSafety()
+            .hate(threshold)
+            .selfHarm(threshold)
+            .sexual(threshold)
+            .violence(threshold);
+    final var configWithFilter =
+        config.withInputFiltering(filterConfig).withOutputFiltering(filterConfig);
 
     return client.chatCompletion(prompt, configWithFilter);
   }
-
-  /**
-   * Helper method to build filter configurations.
-   *
-   * @param threshold The threshold to be applied across all filter categories.
-   * @return A new filter configuration object.
-   */
-  private static FilteringModuleConfig createAzureContentFilter(
-      @Nonnull final AzureThreshold threshold) {
-    final var filter =
-        new AzureContentSafetyFilterConfig()
-            .type(AzureContentSafetyFilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
-            .config(
-                new AzureContentSafety()
-                    .hate(threshold)
-                    .selfHarm(threshold)
-                    .sexual(threshold)
-                    .violence(threshold));
-
-    return new FilteringModuleConfig()
-        .input(new InputFilteringConfig().filters(List.of(filter)))
-        .output(new OutputFilteringConfig().filters(List.of(filter)));
-  }
+  
 
   /**
    * Let the orchestration service evaluate the feedback on the AI SDK provided by a hypothetical