finito

Author: CharlesDuboisSAP

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

@@ -33,6 +33,7 @@ public class DpiMasking implements MaskingProvider {
   @Nonnull DPIConfig.MethodEnum maskingMethod;
   @Nonnull List<DPIEntities> entities;
   boolean maskGroundingInput;
+  @Nonnull List<String> allowList;
 
   /**
    * Build a configuration applying anonymization.
@@ -67,7 +68,7 @@ public static class Builder {
      *
      * @param entity An entity type to mask (required)
      * @param entities Additional entity types to mask (optional)
-     * @return A configured {@link DpiMasking} instance
+     * @return A new {@link DpiMasking} instance
      * @see DPIEntities
      */
     @Nonnull
@@ -76,12 +77,29 @@ public DpiMasking withEntities(
       val entitiesList = new ArrayList<DPIEntities>();
       entitiesList.add(entity);
       entitiesList.addAll(Arrays.asList(entities));
-      return new DpiMasking(maskingMethod, entitiesList, false);
+      return new DpiMasking(maskingMethod, entitiesList, false, List.of());
     }
   }
 
-  public DpiMasking withGroundingEnabled() {
-    return new DpiMasking(maskingMethod, entities, true);
+  /**
+   * If grounding is used, the input text will be masked.
+   *
+   * @return A new {@link DpiMasking} instance
+   */
+  @Nonnull
+  public DpiMasking withMaskGroundingEnabled() {
+    return new DpiMasking(maskingMethod, entities, true, List.of());
+  }
+
+  /**
+   * Set words that should not be masked.
+   *
+   * @param allowList List of strings that should not be masked
+   * @return A new {@link DpiMasking} instance
+   */
+  @Nonnull
+  public DpiMasking withAllowList(@Nonnull final List<String> allowList) {
+    return new DpiMasking(maskingMethod, entities, maskGroundingInput, allowList);
   }
 
   @Nonnull
@@ -92,6 +110,7 @@ public MaskingProviderConfig createConfig() {
         .type(SAP_DATA_PRIVACY_INTEGRATION)
         .method(maskingMethod)
         .entities(entitiesDTO)
-        .maskGroundingInput(DPIConfigMaskGroundingInput.create().enabled(maskGroundingInput));
+        .maskGroundingInput(DPIConfigMaskGroundingInput.create().enabled(maskGroundingInput))
+        .allowlist(allowList);
   }
 }

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

@@ -170,7 +170,13 @@ void testGrounding() throws IOException {
         GroundingModuleConfig.create()
             .type(GroundingModuleConfig.TypeEnum.DOCUMENT_GROUNDING_SERVICE)
             .config(groundingConfigConfig);
-    final var configWithGrounding = config.withGroundingConfig(groundingConfig);
+    val maskingConfig = // optional masking configuration
+        DpiMasking.anonymization()
+            .withEntities(DPIEntities.SENSITIVE_DATA)
+            .withMaskGroundingEnabled()
+            .withAllowList(List.of("SAP", "Joule"));
+    final var configWithGrounding =
+        config.withGroundingConfig(groundingConfig).withMaskingConfig(maskingConfig);
 
     final Map<String, String> inputParams =
         Map.of("query", "String used for similarity search in database");

orchestration/src/test/resources/groundingRequest.json

@@ -21,6 +21,19 @@
         "defaults" : { },
         "tools" : [ ]
       },
+      "masking_module_config" : {
+        "masking_providers" : [ {
+          "type" : "sap_data_privacy_integration",
+          "method" : "anonymization",
+          "entities" : [ {
+            "type" : "profile-sensitive-data"
+          } ],
+          "allowlist" : [ "SAP", "Joule" ],
+          "mask_grounding_input" : {
+            "enabled" : true
+          }
+        } ]
+      },
       "grounding_module_config" : {
         "type" : "document_grounding_service",
         "config" : {
@@ -53,4 +66,4 @@
     "query" : "String used for similarity search in database"
   },
   "messages_history" : [ ]
-}
+}

orchestration/src/test/resources/maskingRequest.json

@@ -33,7 +33,10 @@
                 "type": "profile-phone"
               }
             ],
-            "allowlist" : [ ]
+            "allowlist" : [ ],
+            "mask_grounding_input" : {
+              "enabled" : false
+            }
           }
         ]
       }

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

@@ -335,8 +335,13 @@ public OrchestrationChatResponse grounding(@Nonnull final String userMessage) {
 
     val groundingConfig = Grounding.create().filters(databaseFilter);
     val prompt = groundingConfig.createGroundingPrompt(userMessage);
-    val maskingConfig = DpiMasking.anonymization().withEntities(DPIEntities.PERSON).withGroundingEnabled();
-    val configWithGrounding = config.withGrounding(groundingConfig).withMaskingConfig(maskingConfig);
+    val maskingConfig = // optional masking configuration
+        DpiMasking.anonymization()
+            .withEntities(DPIEntities.SENSITIVE_DATA)
+            .withMaskGroundingEnabled()
+            .withAllowList(List.of("SAP", "Joule"));
+    val configWithGrounding =
+        config.withGrounding(groundingConfig).withMaskingConfig(maskingConfig);
 
     return client.chatCompletion(prompt, configWithGrounding);
   }

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

@@ -176,6 +176,9 @@ void testGrounding() {
     assertThat(result.getModuleResults().getGrounding()).isNotNull();
     assertThat(result.getModuleResults().getGrounding().getData()).isNotNull();
     assertThat(result.getModuleResults().getGrounding().getMessage()).isEqualTo("grounding result");
+
+    var maskingResult = result.getModuleResults().getInputMasking();
+    assertThat(maskingResult.getMessage()).isNotEmpty();
   }
 
   @Test