test: SpringAI Filtering

.gitignore

@@ -28,4 +28,8 @@
 ### Environment ###
 *.env
 
-.openapi-generator
+.openapi-generator
+
+# sub-module spotbugs
+**/.pipeline/spotbugs.xml
+**/.pipeline/spotbugs-exclusions.xml

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

@@ -1,20 +1,28 @@
 package com.sap.ai.sdk.app.controllers;
 
 import com.sap.ai.sdk.app.services.SpringAiOrchestrationService;
+import com.sap.ai.sdk.orchestration.AzureFilterThreshold;
+import com.sap.ai.sdk.orchestration.OrchestrationClientException;
 import com.sap.ai.sdk.orchestration.spring.OrchestrationSpringChatResponse;
+import java.util.Set;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import lombok.extern.slf4j.Slf4j;
 import lombok.val;
 import org.springframework.ai.chat.messages.AssistantMessage;
+import org.springframework.ai.chat.model.ChatResponse;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import reactor.core.publisher.Flux;
 
 @SuppressWarnings("unused")
 @RestController
+@Slf4j
 @RequestMapping("/spring-ai-orchestration")
 class SpringAiOrchestrationController {
   @Autowired private SpringAiOrchestrationService service;
@@ -52,6 +60,50 @@ Object template(@Nullable @RequestParam(value = "format", required = false) fina
     return response.getResult().getOutput().getText();
   }
 
+  @GetMapping("/inputFiltering/{policy}")
+  @Nonnull
+  Object inputFiltering(
+      @Nullable @RequestParam(value = "format", required = false) final String format,
+      @Nonnull @PathVariable("policy") final AzureFilterThreshold policy) {
+
+    final ChatResponse response;
+    try {
+      response = service.inputFiltering(policy);
+    } catch (OrchestrationClientException e) {
+      final var msg = "Failed to obtain a response as the content was flagged by input filter.";
+      log.debug(msg, e);
+      return ResponseEntity.internalServerError().body(msg);
+    }
+
+    if ("json".equals(format)) {
+      return ((OrchestrationSpringChatResponse) response)
+          .getOrchestrationResponse()
+          .getOriginalResponse();
+    }
+    return response.getResult().getOutput().getText();
+  }
+
+  @GetMapping("/outputFiltering/{policy}")
+  @Nonnull
+  Object outputFiltering(
+      @Nullable @RequestParam(value = "format", required = false) final String format,
+      @Nonnull @PathVariable("policy") final AzureFilterThreshold policy) {
+
+    val response = service.outputFiltering(policy);
+
+    if (response.hasFinishReasons(Set.of("content_filter"))) {
+      return ResponseEntity.internalServerError()
+          .body("Failed to obtain a response as the content was flagged by output filter.");
+    }
+
+    if ("json".equals(format)) {
+      return ((OrchestrationSpringChatResponse) response)
+          .getOrchestrationResponse()
+          .getOriginalResponse();
+    }
+    return response.getResult().getOutput().getText();
+  }
+
   @GetMapping("/masking")
   Object masking(@Nullable @RequestParam(value = "format", required = false) final String format) {
     val response = service.masking();

sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/services/SpringAiOrchestrationService.java

@@ -1,8 +1,12 @@
 package com.sap.ai.sdk.app.services;
 
+import static com.sap.ai.sdk.orchestration.OrchestrationAiModel.GEMINI_1_5_FLASH;
 import static com.sap.ai.sdk.orchestration.OrchestrationAiModel.GPT_4O_MINI;
 
+import com.sap.ai.sdk.orchestration.AzureContentFilter;
+import com.sap.ai.sdk.orchestration.AzureFilterThreshold;
 import com.sap.ai.sdk.orchestration.DpiMasking;
+import com.sap.ai.sdk.orchestration.OrchestrationClientException;
 import com.sap.ai.sdk.orchestration.OrchestrationModuleConfig;
 import com.sap.ai.sdk.orchestration.model.DPIEntities;
 import com.sap.ai.sdk.orchestration.spring.OrchestrationChatModel;
@@ -94,6 +98,57 @@ public ChatResponse masking() {
     return client.call(prompt);
   }
 
+  /**
+   * Apply input filtering for a request to orchestration using the SpringAI integration.
+   *
+   * @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 policy the explicitness of content that should be allowed through the filter
+   * @return the assistant response object
+   */
+  @Nonnull
+  public ChatResponse inputFiltering(@Nonnull final AzureFilterThreshold policy)
+      throws OrchestrationClientException {
+    val filterConfig =
+        new AzureContentFilter().hate(policy).selfHarm(policy).sexual(policy).violence(policy);
+    val opts =
+        new OrchestrationChatOptions(
+            config.withLlmConfig(GEMINI_1_5_FLASH).withInputFiltering(filterConfig));
+
+    val prompt =
+        new Prompt(
+            "Please rephrase the following sentence for me: 'We shall spill blood tonight', said the operator in-charge.",
+            opts);
+
+    return client.call(prompt);
+  }
+
+  /**
+   * Apply output filtering for a request to orchestration using the SpringAI integration.
+   *
+   * @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 policy the explicitness of content that should be allowed through the filter
+   * @return the assistant response object
+   */
+  @Nonnull
+  public ChatResponse outputFiltering(@Nonnull final AzureFilterThreshold policy) {
+    val filterConfig =
+        new AzureContentFilter().hate(policy).selfHarm(policy).sexual(policy).violence(policy);
+    val opts =
+        new OrchestrationChatOptions(
+            config.withLlmConfig(GEMINI_1_5_FLASH).withOutputFiltering(filterConfig));
+
+    val prompt =
+        new Prompt(
+            "Please rephrase the following sentence for me: 'We shall spill blood tonight', said the operator in-charge.",
+            opts);
+
+    return client.call(prompt);
+  }
+
   /**
    * Turn a method into a tool by annotating it with @Tool. <a
    * href="https://docs.spring.io/spring-ai/reference/api/tools.html#_methods_as_tools">Spring AI

sample-code/spring-app/src/main/resources/static/index.html

@@ -691,6 +691,30 @@ <h5 class="mb-1">Orchestration Integration</h5>
                                     </div>
                                 </div>
                             </li>
+                            <li class="list-group-item">
+                                <div class="info-tooltip">
+                                    <button type="submit"
+                                            formaction="/spring-ai-orchestration/inputFiltering/ALLOW_SAFE"
+                                            class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
+                                        <code>/spring-ai-orchestration/inputFiltering/ALLOW_SAFE</code>
+                                    </button>
+                                    <div class="tooltip-content">
+                                        Apply strict input filtering for a request to orchestration using the SpringAI integration.
+                                    </div>
+                                </div>
+                            </li>
+                            <li class="list-group-item">
+                                <div class="info-tooltip">
+                                    <button type="submit"
+                                            formaction="/spring-ai-orchestration/outputFiltering/ALLOW_SAFE"
+                                            class="link-offset-2-hover link-underline link-underline-opacity-0 link-underline-opacity-75-hover endpoint">
+                                        <code>/spring-ai-orchestration/outputFiltering/ALLOW_SAFE</code>
+                                    </button>
+                                    <div class="tooltip-content">
+                                        Apply strict output filtering for a request to orchestration using the SpringAI integration.
+                                    </div>
+                                </div>
+                            </li>
                             <li class="list-group-item">
                                 <div class="info-tooltip">
                                     <button type="submit"

sample-code/spring-app/src/test/java/com/sap/ai/sdk/app/controllers/SpringAiOrchestrationTest.java

@@ -4,7 +4,9 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import com.sap.ai.sdk.app.services.SpringAiOrchestrationService;
+import com.sap.ai.sdk.orchestration.AzureFilterThreshold;
 import com.sap.ai.sdk.orchestration.OrchestrationClientException;
+import com.sap.ai.sdk.orchestration.spring.OrchestrationSpringChatResponse;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
 import lombok.extern.slf4j.Slf4j;
@@ -58,6 +60,71 @@ void testMasking() {
     assertThat(response.getResult().getOutput().getText()).isNotEmpty();
   }
 
+  @Test
+  void testInputFilteringStrict() {
+    var policy = AzureFilterThreshold.ALLOW_SAFE;
+
+    assertThatThrownBy(() -> service.inputFiltering(policy))
+        .isInstanceOf(OrchestrationClientException.class)
+        .hasMessageContaining(
+            "Content filtered due to safety violations. Please modify the prompt and try again.")
+        .hasMessageContaining("400 Bad Request");
+  }
+
+  @Test
+  void testInputFilteringLenient() {
+    var policy = AzureFilterThreshold.ALLOW_ALL;
+
+    var response = service.inputFiltering(policy);
+
+    assertThat(response.getResult().getMetadata().getFinishReason()).isEqualTo("stop");
+    assertThat(response.getResult().getOutput().getText()).isNotEmpty();
+
+    var filterResult =
+        ((OrchestrationSpringChatResponse) response)
+            .getOrchestrationResponse()
+            .getOriginalResponse()
+            .getModuleResults()
+            .getInputFiltering();
+    assertThat(filterResult.getMessage()).contains("passed");
+  }
+
+  @Test
+  void testOutputFilteringStrict() {
+    var policy = AzureFilterThreshold.ALLOW_SAFE;
+
+    var response = service.outputFiltering(policy);
+
+    assertThat(response.getResult().getMetadata().getFinishReason()).isEqualTo("content_filter");
+    assertThat(response.getResult().getOutput().getText()).isEmpty();
+
+    var filterResult =
+        ((OrchestrationSpringChatResponse) response)
+            .getOrchestrationResponse()
+            .getOriginalResponse()
+            .getModuleResults()
+            .getOutputFiltering();
+    assertThat(filterResult.getMessage()).containsPattern("1 of 1 choices failed");
+  }
+
+  @Test
+  void testOutputFilteringLenient() {
+    var policy = AzureFilterThreshold.ALLOW_ALL;
+
+    var response = service.outputFiltering(policy);
+
+    assertThat(response.getResult().getMetadata().getFinishReason()).isEqualTo("stop");
+    assertThat(response.getResult().getOutput().getText()).isNotEmpty();
+
+    var filterResult =
+        ((OrchestrationSpringChatResponse) response)
+            .getOrchestrationResponse()
+            .getOriginalResponse()
+            .getModuleResults()
+            .getOutputFiltering();
+    assertThat(filterResult.getMessage()).containsPattern("0 of \\d+ choices failed");
+  }
+
   @Test
   void testToolCallingWithoutExecution() {
     ChatResponse response = service.toolCalling(false);