Merge branch 'main' into Using-Prompt-Registry-Templates-in-SpringAi

Author: n-o-u-r-h-a-n

.github/workflows/continuous-integration.yaml

@@ -15,6 +15,8 @@ jobs:
 
   continuous-integration:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
 
       - name: "Checkout repository"

.github/workflows/dependency-test.yaml

@@ -10,6 +10,8 @@ env:
 jobs:
   fetch-dependency-versions:
     runs-on: ubuntu-latest
+    permissions:
+      contents: none
     outputs:
       versions: ${{ steps.fetch-versions.outputs.VERSIONS }}
 
@@ -39,6 +41,8 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       cache-key: ${{ steps.cache-build.outputs.cache-key }}
+    permissions:
+      contents: read
     steps:
       - name: "Checkout repository"
         uses: actions/checkout@v4
@@ -75,6 +79,8 @@ jobs:
       matrix:
         version: ${{ fromJson(needs.fetch-dependency-versions.outputs.versions) }}
     continue-on-error: true
+    permissions:
+      contents: read
     steps:
       - name: "Checkout repository"
         uses: actions/checkout@v4

.github/workflows/deploy-snapshot.yaml

@@ -7,9 +7,11 @@ on:
 
 jobs:
   deploy-snapshot:
-    name: Deploy Snapshot
+    name: "Deploy Snapshot"
     runs-on: ubuntu-latest
     timeout-minutes: 15
+    permissions:
+      contents: read
     steps:
       - name: "Checkout Repository"
         uses: actions/checkout@v4

.github/workflows/e2e-test.yaml

@@ -10,6 +10,8 @@ env:
 
 jobs:
   end-to-end-tests:
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       matrix:
@@ -41,6 +43,12 @@ jobs:
       - name: "Run tests"
         id: run_tests
         run: |
+          if [ "${{ matrix.environment }}" = "canary" ]; then
+              export AICORE_SERVICE_KEY="${{ secrets.AI_CORE_CANARY }}"
+          else
+              export AICORE_SERVICE_KEY="${{ secrets.AI_CORE_PRODUCTION }}"
+          fi
+          
           MVN_ARGS="${{ env.MVN_MULTI_THREADED_ARGS }} surefire:test -pl :spring-app -DskipTests=false"
           mvn $MVN_ARGS "-Daicore.landscape=${{ matrix.environment }}" | tee mvn_output.log # tee writes to both the console and a file
 
@@ -60,10 +68,17 @@ jobs:
           fi
         env:
           # See "End-to-end test application instructions" on the README.md to update the secret
-          AICORE_SERVICE_KEY: ${{ secrets[matrix.secret-name] }}
+          AI_CORE_PRODUCTION: ${{ secrets.production }}
+          AI_CORE_CANARY: ${{ secrets.canary }}
 
       - name: "Start Application Locally"
         run: |
+          if [ "${{ matrix.environment }}" = "canary" ]; then
+              export AICORE_SERVICE_KEY="${{ secrets.AI_CORE_CANARY }}"
+          else
+              export AICORE_SERVICE_KEY="${{ secrets.AI_CORE_PRODUCTION }}"
+          fi
+          
           cd sample-code/spring-app
           mvn spring-boot:run &
           timeout=15
@@ -77,7 +92,8 @@ jobs:
           done
         env:
           # See "End-to-end test application instructions" on the README.md to update the secret
-          AICORE_SERVICE_KEY: ${{ secrets[matrix.secret-name] }}
+          AI_CORE_PRODUCTION: ${{ secrets.production }}
+          AI_CORE_CANARY: ${{ secrets.canary }}
 
       - name: "Health Check"
         # print response body with headers to stdout.  q:body only  O:print  -:stdout  S:headers

.github/workflows/fosstars-report.yml

@@ -13,8 +13,11 @@ env:
 
 jobs:
   create_fosstars_report:
-    runs-on: ubuntu-latest
     name: "Security rating"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      actions: write
     steps:
       - name: "Checkout repository"
         uses: actions/checkout@v4

.github/workflows/prepare-release.yaml

@@ -28,6 +28,8 @@ jobs:
       release-commit: ${{ steps.prepare-release.outputs.RELEASE_COMMIT_ID }}
       release-tag: ${{ steps.prepare-release.outputs.TAG_NAME }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: "Checkout Repository"
         uses: actions/checkout@v4
@@ -155,6 +157,9 @@ jobs:
     outputs:
       pr-url: ${{ steps.create-release-notes-pr.outputs.PR_URL }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
       - name: "Checkout Code Repository"
         uses: actions/checkout@v4
@@ -233,6 +238,9 @@ jobs:
     outputs:
       pr-url: ${{ steps.create-code-pr.outputs.PR_URL }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
       - name: "Checkout Repository"
         uses: actions/checkout@v4

.github/workflows/weekly-spec-update.yaml

@@ -7,6 +7,9 @@ on:
 jobs:
   update-all-specs:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
 
     strategy:
       matrix:

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

@@ -6,6 +6,7 @@
 import com.sap.ai.sdk.orchestration.model.InputFilteringConfig;
 import com.sap.ai.sdk.orchestration.model.LLMModelDetails;
 import com.sap.ai.sdk.orchestration.model.MaskingModuleConfig;
+import com.sap.ai.sdk.orchestration.model.MaskingModuleConfigProviders;
 import com.sap.ai.sdk.orchestration.model.OutputFilteringConfig;
 import com.sap.ai.sdk.orchestration.model.PromptTemplatingModuleConfigPrompt;
 import com.sap.ai.sdk.orchestration.model.SAPDocumentTranslation;
@@ -130,9 +131,9 @@ public OrchestrationModuleConfig withMaskingConfig(
       @Nonnull final MaskingProvider maskingProvider,
       @Nonnull final MaskingProvider... maskingProviders) {
     val newMaskingConfig =
-        MaskingModuleConfig.create().maskingProviders(maskingProvider.createConfig());
+        MaskingModuleConfigProviders.create().providers(maskingProvider.createConfig());
     Arrays.stream(maskingProviders)
-        .forEach(it -> newMaskingConfig.addMaskingProvidersItem(it.createConfig()));
+        .forEach(it -> newMaskingConfig.addProvidersItem(it.createConfig()));
 
     return withMaskingConfig(newMaskingConfig);
   }

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

@@ -24,7 +24,10 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
-/** LLMModelDetails */
+/**
+ * The model and parameters to be used for the prompt templating. This is the model that will be
+ * used to generate the response.
+ */
 // CHECKSTYLE:OFF
 public class LLMModelDetails
 // CHECKSTYLE:ON

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

@@ -11,205 +11,13 @@
 
 package com.sap.ai.sdk.orchestration.model;
 
-import com.fasterxml.jackson.annotation.JsonAnyGetter;
-import com.fasterxml.jackson.annotation.JsonAnySetter;
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.NoSuchElementException;
-import java.util.Objects;
-import java.util.Set;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
 
 /** MaskingModuleConfig */
-// CHECKSTYLE:OFF
-public class MaskingModuleConfig
-// CHECKSTYLE:ON
-{
-  @JsonProperty("masking_providers")
-  private List<DPIConfig> maskingProviders = new ArrayList<>();
-
-  @JsonAnySetter @JsonAnyGetter
-  private final Map<String, Object> cloudSdkCustomFields = new LinkedHashMap<>();
-
-  /** Default constructor for MaskingModuleConfig. */
-  protected MaskingModuleConfig() {}
-
-  /**
-   * Set the maskingProviders of this {@link MaskingModuleConfig} instance and return the same
-   * instance.
-   *
-   * @param maskingProviders List of masking service providers
-   * @return The same instance of this {@link MaskingModuleConfig} class
-   */
-  @Nonnull
-  public MaskingModuleConfig maskingProviders(@Nonnull final List<DPIConfig> maskingProviders) {
-    this.maskingProviders = maskingProviders;
-    return this;
-  }
-
-  /**
-   * Add one maskingProviders instance to this {@link MaskingModuleConfig}.
-   *
-   * @param maskingProvidersItem The maskingProviders that should be added
-   * @return The same instance of type {@link MaskingModuleConfig}
-   */
-  @Nonnull
-  public MaskingModuleConfig addMaskingProvidersItem(
-      @Nonnull final DPIConfig maskingProvidersItem) {
-    if (this.maskingProviders == null) {
-      this.maskingProviders = new ArrayList<>();
-    }
-    this.maskingProviders.add(maskingProvidersItem);
-    return this;
-  }
-
-  /**
-   * List of masking service providers
-   *
-   * @return maskingProviders The maskingProviders of this {@link MaskingModuleConfig} instance.
-   */
-  @Nonnull
-  public List<DPIConfig> getMaskingProviders() {
-    return maskingProviders;
-  }
-
-  /**
-   * Set the maskingProviders of this {@link MaskingModuleConfig} instance.
-   *
-   * @param maskingProviders List of masking service providers
-   */
-  public void setMaskingProviders(@Nonnull final List<DPIConfig> maskingProviders) {
-    this.maskingProviders = maskingProviders;
-  }
-
-  /**
-   * Get the names of the unrecognizable properties of the {@link MaskingModuleConfig}.
-   *
-   * @return The set of properties names
-   */
-  @JsonIgnore
-  @Nonnull
-  public Set<String> getCustomFieldNames() {
-    return cloudSdkCustomFields.keySet();
-  }
-
-  /**
-   * Get the value of an unrecognizable property of this {@link MaskingModuleConfig} instance.
-   *
-   * @deprecated Use {@link #toMap()} instead.
-   * @param name The name of the property
-   * @return The value of the property
-   * @throws NoSuchElementException If no property with the given name could be found.
-   */
-  @Nullable
-  @Deprecated
-  public Object getCustomField(@Nonnull final String name) throws NoSuchElementException {
-    if (!cloudSdkCustomFields.containsKey(name)) {
-      throw new NoSuchElementException(
-          "MaskingModuleConfig has no field with name '" + name + "'.");
-    }
-    return cloudSdkCustomFields.get(name);
-  }
-
-  /**
-   * Get the value of all properties of this {@link MaskingModuleConfig} instance including
-   * unrecognized properties.
-   *
-   * @return The map of all properties
-   */
-  @JsonIgnore
-  @Nonnull
-  public Map<String, Object> toMap() {
-    final Map<String, Object> declaredFields = new LinkedHashMap<>(cloudSdkCustomFields);
-    if (maskingProviders != null) declaredFields.put("maskingProviders", maskingProviders);
-    return declaredFields;
-  }
-
-  /**
-   * Set an unrecognizable property of this {@link MaskingModuleConfig} instance. If the map
-   * previously contained a mapping for the key, the old value is replaced by the specified value.
-   *
-   * @param customFieldName The name of the property
-   * @param customFieldValue The value of the property
-   */
-  @JsonIgnore
-  public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue) {
-    cloudSdkCustomFields.put(customFieldName, customFieldValue);
-  }
-
-  @Override
-  public boolean equals(@Nullable final java.lang.Object o) {
-    if (this == o) {
-      return true;
-    }
-    if (o == null || getClass() != o.getClass()) {
-      return false;
-    }
-    final MaskingModuleConfig maskingModuleConfig = (MaskingModuleConfig) o;
-    return Objects.equals(this.cloudSdkCustomFields, maskingModuleConfig.cloudSdkCustomFields)
-        && Objects.equals(this.maskingProviders, maskingModuleConfig.maskingProviders);
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(maskingProviders, cloudSdkCustomFields);
-  }
-
-  @Override
-  @Nonnull
-  public String toString() {
-    final StringBuilder sb = new StringBuilder();
-    sb.append("class MaskingModuleConfig {\n");
-    sb.append("    maskingProviders: ").append(toIndentedString(maskingProviders)).append("\n");
-    cloudSdkCustomFields.forEach(
-        (k, v) ->
-            sb.append("    ").append(k).append(": ").append(toIndentedString(v)).append("\n"));
-    sb.append("}");
-    return sb.toString();
-  }
-
-  /**
-   * Convert the given object to string with each line indented by 4 spaces (except the first line).
-   */
-  private String toIndentedString(final java.lang.Object o) {
-    if (o == null) {
-      return "null";
-    }
-    return o.toString().replace("\n", "\n    ");
-  }
-
-  /**
-   * Create a type-safe, fluent-api builder object to construct a new {@link MaskingModuleConfig}
-   * instance with all required arguments.
-   */
-  public static Builder create() {
-    return (maskingProviders) -> new MaskingModuleConfig().maskingProviders(maskingProviders);
-  }
-
-  /** Builder helper class. */
-  public interface Builder {
-    /**
-     * Set the maskingProviders of this {@link MaskingModuleConfig} instance.
-     *
-     * @param maskingProviders List of masking service providers
-     * @return The MaskingModuleConfig instance.
-     */
-    MaskingModuleConfig maskingProviders(@Nonnull final List<DPIConfig> maskingProviders);
-
-    /**
-     * Set the maskingProviders of this {@link MaskingModuleConfig} instance.
-     *
-     * @param maskingProviders List of masking service providers
-     * @return The MaskingModuleConfig instance.
-     */
-    default MaskingModuleConfig maskingProviders(@Nonnull final DPIConfig... maskingProviders) {
-      return maskingProviders(Arrays.asList(maskingProviders));
-    }
-  }
-}
+@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
+@JsonSubTypes({
+  @JsonSubTypes.Type(value = MaskingModuleConfigMaskingProviders.class),
+  @JsonSubTypes.Type(value = MaskingModuleConfigProviders.class),
+})
+public interface MaskingModuleConfig {}