Merge remote-tracking branch 'origin/main' into feat/orchestration/springai-embed

# Conflicts:
#	foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/spring/OpenAiSpringEmbeddingModel.java

Author: rpanackal

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,4 +1,4 @@
-name: Bug Report
+name: Problem/Bug Report
 description: Released feature does not work as expected in the SAP Cloud SDK for AI (Java).
 labels:
   - bug
@@ -11,8 +11,8 @@ body:
         **Missing information may result in delayed response**
   - type: textarea
     attributes:
-      label: "Describe the Bug"
-      description: "A clear and concise description of what the bug is."
+      label: "Describe the Problem/Bug"
+      description: "A clear and concise description of what the problem/bug is."
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/question.yml

@@ -201,12 +201,12 @@ jobs:
         run: |
           PR_TITLE="Java: Add release notes for release ${{ needs.bump-version.outputs.release-version }}"
 
-          # if the minor version is a multiple of 15, then change the PR_BODY to "# ⚠️Update the `docs-java/release-notes/index.jsx` file⚠️"
+          # if the minor version is a multiple of 15, then change the PR_BODY to "# ⚠️Update the `docs-java/release-notes.mdx` file⚠️"
           # else the PR_BODY will be "Add the SAP Cloud SDK ${{ needs.bump-version.outputs.release-version }} release notes"
 
           minor_version=$(echo ${{ needs.bump-version.outputs.release-version }} | cut -d '.' -f 2)
           if [[ $((minor_version % 15)) -eq 0 ]]; then
-            PR_BODY="# ⚠️Update the \`docs-java/release-notes/index.jsx\` file⚠️"
+            PR_BODY="# ⚠️Update the \`docs-java/release-notes.mdx\` file⚠️"
           else
             PR_BODY="Add the SAP Cloud SDK ${{ needs.bump-version.outputs.release-version }} release notes"
           fi

.github/workflows/prepare-release.yaml

@@ -57,7 +57,7 @@
 
 ### 📈 Improvements
 
--
+- [Orchestration] Added new API `DpiMasking#withRegex` to apply custom masking patterns.
 
 ### 🐛 Fixed Issues
 

docs/release_notes.md

@@ -6,12 +6,14 @@
 
 import com.sap.ai.sdk.orchestration.model.DPIConfig;
 import com.sap.ai.sdk.orchestration.model.DPIConfigMaskGroundingInput;
+import com.sap.ai.sdk.orchestration.model.DPICustomEntity;
 import com.sap.ai.sdk.orchestration.model.DPIEntities;
 import com.sap.ai.sdk.orchestration.model.DPIEntityConfig;
+import com.sap.ai.sdk.orchestration.model.DPIMethodConstant;
 import com.sap.ai.sdk.orchestration.model.DPIStandardEntity;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 import lombok.AccessLevel;
 import lombok.Getter;
@@ -32,7 +34,7 @@
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 public class DpiMasking implements MaskingProvider {
   @Nonnull DPIConfig.MethodEnum maskingMethod;
-  @Nonnull List<DPIEntities> entities;
+  @Nonnull List<DPIEntityConfig> entitiesConfig;
   @With boolean maskGroundingInput;
   @Nonnull List<String> allowList;
 
@@ -75,11 +77,53 @@ public static class Builder {
     @Nonnull
     public DpiMasking withEntities(
         @Nonnull final DPIEntities entity, @Nonnull final DPIEntities... entities) {
-      val entitiesList = new ArrayList<DPIEntities>();
-      entitiesList.add(entity);
-      entitiesList.addAll(Arrays.asList(entities));
-      return new DpiMasking(maskingMethod, entitiesList, false, List.of());
+      val entitiesConfig =
+          Stream.concat(Stream.of(entity), Arrays.stream(entities))
+              .map(it -> (DPIEntityConfig) DPIStandardEntity.create().type(it))
+              .toList();
+      return new DpiMasking(maskingMethod, entitiesConfig, false, List.of());
     }
+
+    /**
+     * Adds a custom regex pattern for masking.
+     *
+     * @param regex The regex pattern to match
+     * @param replacement The replacement string
+     * @return A new {@link DpiMasking} instance
+     */
+    @Nonnull
+    public DpiMasking withRegex(@Nonnull final String regex, @Nonnull final String replacement) {
+      val customEntity =
+          DPICustomEntity.create()
+              .regex(regex)
+              .replacementStrategy(
+                  DPIMethodConstant.create()
+                      .method(DPIMethodConstant.MethodEnum.CONSTANT)
+                      .value(replacement));
+
+      return new DpiMasking(maskingMethod, List.of(customEntity), false, List.of());
+    }
+  }
+
+  /**
+   * Specifies a custom regex pattern for masking.
+   *
+   * @param regex The regex pattern to match
+   * @param replacement The replacement string
+   * @return A new {@link DpiMasking} instance
+   */
+  @Nonnull
+  public DpiMasking withRegex(@Nonnull final String regex, @Nonnull final String replacement) {
+    val customEntity =
+        DPICustomEntity.create()
+            .regex(regex)
+            .replacementStrategy(
+                DPIMethodConstant.create()
+                    .method(DPIMethodConstant.MethodEnum.CONSTANT)
+                    .value(replacement));
+    val newEntities = new java.util.ArrayList<>(entitiesConfig);
+    newEntities.add(customEntity);
+    return new DpiMasking(maskingMethod, newEntities, maskGroundingInput, allowList);
   }
 
   /**
@@ -90,18 +134,16 @@ public DpiMasking withEntities(
    */
   @Nonnull
   public DpiMasking withAllowList(@Nonnull final List<String> allowList) {
-    return new DpiMasking(maskingMethod, entities, maskGroundingInput, allowList);
+    return new DpiMasking(maskingMethod, entitiesConfig, maskGroundingInput, allowList);
   }
 
   @Nonnull
   @Override
   public DPIConfig createConfig() {
-    val entitiesDTO =
-        entities.stream().map(it -> (DPIEntityConfig) DPIStandardEntity.create().type(it)).toList();
     return DPIConfig.create()
         .type(SAP_DATA_PRIVACY_INTEGRATION)
         .method(maskingMethod)
-        .entities(entitiesDTO)
+        .entities(entitiesConfig)
         .maskGroundingInput(DPIConfigMaskGroundingInput.create().enabled(maskGroundingInput))
         .allowlist(allowList);
   }

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

@@ -10,7 +10,9 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.sap.ai.sdk.orchestration.model.DPIConfig;
+import com.sap.ai.sdk.orchestration.model.DPICustomEntity;
 import com.sap.ai.sdk.orchestration.model.DPIEntities;
+import com.sap.ai.sdk.orchestration.model.DPIMethodConstant;
 import com.sap.ai.sdk.orchestration.model.DPIStandardEntity;
 import com.sap.ai.sdk.orchestration.model.DocumentGroundingFilter;
 import com.sap.ai.sdk.orchestration.model.GroundingModuleConfigConfig;
@@ -106,6 +108,36 @@ void testDpiMaskingConfig() {
         .hasSize(1);
   }
 
+  @Test
+  void testDpiMaskingRegex() {
+    var masking =
+        DpiMasking.anonymization()
+            .withRegex("\\d{3}-\\d{2}-\\d{4}", "***-**-****")
+            .withRegex("\\d{2}-\\d{2}-\\d{5}", "**-**-*****");
+    var config = new OrchestrationModuleConfig().withLlmConfig(GPT_4O).withMaskingConfig(masking);
+    assertThat(config.getMaskingConfig()).isNotNull();
+    assertThat(((MaskingModuleConfigProviders) config.getMaskingConfig()).getProviders())
+        .hasSize(1);
+    DPIConfig dpiConfig =
+        ((MaskingModuleConfigProviders) config.getMaskingConfig()).getProviders().get(0);
+    assertThat(dpiConfig.getMethod()).isEqualTo(DPIConfig.MethodEnum.ANONYMIZATION);
+    assertThat(dpiConfig.getEntities()).hasSize(2);
+    assertThat(((DPICustomEntity) dpiConfig.getEntities().get(0)).getRegex())
+        .isEqualTo("\\d{3}-\\d{2}-\\d{4}");
+    assertThat(((DPICustomEntity) dpiConfig.getEntities().get(0)).getReplacementStrategy())
+        .isEqualTo(
+            DPIMethodConstant.create()
+                .method(DPIMethodConstant.MethodEnum.CONSTANT)
+                .value("***-**-****"));
+    assertThat(((DPICustomEntity) dpiConfig.getEntities().get(1)).getRegex())
+        .isEqualTo("\\d{2}-\\d{2}-\\d{5}");
+    assertThat(((DPICustomEntity) dpiConfig.getEntities().get(1)).getReplacementStrategy())
+        .isEqualTo(
+            DPIMethodConstant.create()
+                .method(DPIMethodConstant.MethodEnum.CONSTANT)
+                .value("**-**-*****"));
+  }
+
   @Test
   void testParams() {
     // test withParams(Map<String, Object>)

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

@@ -60,7 +60,7 @@
     <wiremock.version>3.13.1</wiremock.version>
     <assertj-core.version>3.27.6</assertj-core.version>
     <slf4j.version>2.0.17</slf4j.version>
-    <checkstyle.version>11.1.0</checkstyle.version>
+    <checkstyle.version>12.0.1</checkstyle.version>
     <system-stubs.version>2.1.3</system-stubs.version>
     <surefire.version>3.5.4</surefire.version>
     <springframework.version>6.2.11</springframework.version>
@@ -632,7 +632,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
-        <version>3.27.0</version>
+        <version>3.28.0</version>
         <configuration>
           <rulesets>
             <ruleset>${project.rootdir}/.pipeline/pmd.xml</ruleset>
@@ -667,7 +667,7 @@ https://gitbox.apache.org/repos/asf?p=maven-pmd-plugin.git;a=blob_plain;f=src/ma
       <plugin>
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
-        <version>0.8.13</version>
+        <version>0.8.14</version>
         <configuration>
           <excludes>
             <!-- Exclude generated clients and end to end application from test coverage -->

pom.xml

@@ -36,7 +36,7 @@
     <spring-boot.version>3.5.6</spring-boot.version>
     <logback.version>1.5.19</logback.version>
     <cf-logging.version>3.8.6</cf-logging.version>
-    <apache-tomcat-embed.version>11.0.11</apache-tomcat-embed.version>
+    <apache-tomcat-embed.version>11.0.12</apache-tomcat-embed.version>
     <!-- Skip end-to-end tests by default, can be overridden with -DskipTests=false -->
     <skipTests>true</skipTests>
     <!-- Allow logging frameworks because this module is not released -->

sample-code/spring-app/pom.xml

@@ -216,6 +216,17 @@ Object maskingAnonymization(
     return response.getContent();
   }
 
+  @GetMapping("/maskingRegex")
+  @Nonnull
+  Object maskingRegex(
+      @Nullable @RequestParam(value = "format", required = false) final String format) {
+    final var response = service.maskingRegex();
+    if ("json".equals(format)) {
+      return response;
+    }
+    return response.getContent();
+  }
+
   @GetMapping("/completion/{resourceGroup}")
   @Nonnull
   Object completionWithResourceGroup(

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

@@ -267,9 +267,9 @@ public OrchestrationChatResponse maskingAnonymization(@Nonnull final DPIEntities
     val 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.
-                            """);
+    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.
+    """);
 
     val prompt = new OrchestrationPrompt(systemMessage, userMessage);
     val maskingConfig = DpiMasking.anonymization().withEntities(entity);
@@ -278,6 +278,28 @@ public OrchestrationChatResponse maskingAnonymization(@Nonnull final DPIEntities
     return client.chatCompletion(prompt, configWithMasking);
   }
 
+  /**
+   * Let the LLM respond with a masked repeated phrase of patient IDs.
+   *
+   * @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>
+   * @return the assistant response object
+   */
+  @Nonnull
+  public OrchestrationChatResponse maskingRegex() {
+    val systemMessage = Message.system("Repeat following messages");
+    val userMessage = Message.user("The patient id is patient_id_123.");
+
+    val prompt = new OrchestrationPrompt(systemMessage, userMessage);
+    val regex = "patient_id_[0-9]+";
+    val replacement = "REDACTED_ID";
+    val maskingConfig = DpiMasking.anonymization().withRegex(regex, replacement);
+    val configWithMasking = config.withMaskingConfig(maskingConfig);
+
+    return client.chatCompletion(prompt, configWithMasking);
+  }
+
   /**
    * Chat request to OpenAI through the Orchestration deployment under a specific resource group.
    *