Merge branch 'main' into doc/cloud-sdk-requirements

Author: newtork

.github/workflows/continuous-integration.yaml

@@ -22,6 +22,7 @@ jobs:
         with:
           fetch-depth: 1
           ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: "Setup java"
         uses: actions/setup-java@v4

.github/workflows/dependency-test.yaml

@@ -0,0 +1,124 @@
+name: Test SAP Cloud SDK Versions
+
+on:
+  workflow_dispatch:
+
+env:
+  MVN_MULTI_THREADED_ARGS: --batch-mode --no-transfer-progress --fail-at-end --show-version --threads 1C
+  JAVA_VERSION: 17
+
+jobs:
+  fetch-dependency-versions:
+    runs-on: ubuntu-latest
+    outputs:
+      versions: ${{ steps.fetch-versions.outputs.VERSIONS }}
+
+    steps:
+      - name: Fetch versions from Maven Central
+        id: fetch-versions
+        run: |
+          # Specify the dependency coordinates
+          GROUP_ID="com.sap.cloud.sdk"
+          ARTIFACT_ID="sdk-bom"
+
+          # Fetch available versions from Maven Central API
+          response=$(curl -s "https://search.maven.org/solrsearch/select?q=g:%22${GROUP_ID}%22+AND+a:%22${ARTIFACT_ID}%22&rows=15&core=gav&wt=json")
+          
+          # Extract and filter versions (e.g., to exclude snapshots or specific versions)
+          versions=$(echo "$response" | jq -r '.response.docs[].v' | grep -v -E 'SNAPSHOT|alpha|beta' | sort -V)
+          
+          # Convert the versions to a JSON array
+          json_versions=$(echo "$versions" | jq -R . | jq -s . | tr -d '\n')
+          
+          echo "JSON Versions: $json_versions"
+          
+          # Output the versions as a string that can be used in the matrix
+          echo "VERSIONS=${json_versions}" >> $GITHUB_OUTPUT
+
+  setup-environment:
+    runs-on: ubuntu-latest
+    outputs:
+      cache-key: ${{ steps.cache-build.outputs.cache-key }}
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup java"
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: ${{ env.JAVA_VERSION }}
+          cache: 'maven'
+
+      - name: "Cache build"
+        id: cache-build
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.m2/repository
+            target
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: "Build SDK"
+        run: |
+          MVN_ARGS="${{ env.MVN_MULTI_THREADED_ARGS }} clean install -DskipTests -DskipFormatting"
+          mvn $MVN_ARGS
+
+  test-dependency-versions:
+    needs: [ fetch-dependency-versions, setup-environment ]
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      fail-fast: false
+      matrix:
+        version: ${{ fromJson(needs.fetch-dependency-versions.outputs.versions) }}
+    continue-on-error: true
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup java"
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: ${{ env.JAVA_VERSION }}
+          cache: 'maven'
+
+      - name: "Restore build cache"
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.m2/repository
+            target
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+
+      - name: "Run tests with explicit version"
+        run: |
+          MVN_ARGS="${{ env.MVN_MULTI_THREADED_ARGS }} clean package -pl :spring-app -DskipTests=false -DskipFormatting -Dcloud-sdk.version=${{ matrix.version }} -Denforcer.skip=true -Dspotless.skip=true"
+          mvn $MVN_ARGS
+        env:
+          # See "End-to-end test application instructions" on the README.md to update the secret
+          AICORE_SERVICE_KEY: ${{ secrets.AICORE_SERVICE_KEY }}
+
+      - name: "Start Application Locally"
+        run: |
+          cd sample-code/spring-app
+          mvn spring-boot:run &
+          timeout=15
+          while ! nc -z localhost 8080; do
+            sleep 1
+            timeout=$((timeout - 1))
+            if [ $timeout -le 0 ]; then
+              echo "Server did not start within 15 seconds."
+              exit 1
+            fi
+          done
+        env:
+          # See "End-to-end test application instructions" on the README.md to update the secret
+          AICORE_SERVICE_KEY: ${{ secrets.AICORE_SERVICE_KEY }}
+
+      - name: "Health Check"
+        # print response body with headers to stdout.  q:body only  O:print  -:stdout  S:headers
+        run: wget -qO- -S localhost:8080

.github/workflows/e2e-test.yaml

@@ -2,7 +2,7 @@ name: "End-to-end Tests"
 on:
   workflow_dispatch:
   schedule:
-    - cron: 0 22 * * *
+    - cron: 0 2 * * *
 
 env:
   MVN_MULTI_THREADED_ARGS: --batch-mode --no-transfer-progress --fail-at-end --show-version --threads 1C

.github/workflows/perform-release.yml

@@ -88,9 +88,6 @@ jobs:
         with:
           distribution: "sapmachine"
           java-version: ${{ env.JAVA_VERSION }}
-          server-id: ossrh
-          server-username: MAVEN_CENTRAL_USER # env variable for username in deploy
-          server-password: MAVEN_CENTRAL_PASSWORD # env variable for token in deploy
 
       - name: "Download Release Asset"
         id: download-asset
@@ -113,8 +110,8 @@ jobs:
 
       - name: "Deploy"
         run: |
-          MVN_ARGS="${{ env.MVN_CLI_ARGS }} deploy -Drelease -s settings.xml"
-          mvn $MVN_ARGS
+          MVN_ARGS="${{ env.MVN_CLI_ARGS }} -Drelease -s settings.xml"
+          mvn deploy $MVN_ARGS
         env:
           MAVEN_GPG_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
 

README.md

@@ -171,7 +171,7 @@ After restarting your application, you should see an "aicore" entry in the `VCAP
 
     - **Name**: `my-aicore`
     - **Type**: `HTTP`
-    - **URL**: `[serviceurls.AI_API_URL]/v2` (append `/v2` to the URL)
+    - **URL**: `[serviceurls.AI_API_URL]`
     - **Proxy Type**: `Internet`
     - **Authentication**: `OAuth2ClientCredentials`
     - **Client ID**: `[clientid]`

core/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.sap.ai.sdk</groupId>
     <artifactId>sdk-parent</artifactId>
-    <version>0.2.0-SNAPSHOT</version>
+    <version>0.3.0-SNAPSHOT</version>
   </parent>
   <artifactId>core</artifactId>
   <name>AI Core client</name>

docs/guides/ORCHESTRATION_CHAT_COMPLETION.md

@@ -77,7 +77,7 @@ To use the Orchestration service, create a client and a configuration object:
 var client = new OrchestrationClient();
 
 var config = new OrchestrationModuleConfig()
-        .withLlmConfig(LLMModuleConfig.create().modelName("gpt-35-turbo").modelParams(Map.of()));
+        .withLlmConfig(OrchestrationAiModel.GPT_4O);
 ```
 
 Please also refer to [our sample code](../../sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/OrchestrationController.java) for this and all following code examples.
@@ -91,8 +91,7 @@ var prompt = new OrchestrationPrompt("Hello world! Why is this phrase so famous?
 
 var result = client.chatCompletion(prompt, config);
 
-String messageResult =
-        result.getOrchestrationResult().getChoices().get(0).getMessage().getContent();
+String messageResult = result.getContent();
 ```
 
 In this example, the Orchestration service generates a response to the user message "Hello world! Why is this phrase so famous?".
@@ -147,33 +146,20 @@ var prompt = new OrchestrationPrompt(
         ```DISCLAIMER: The area surrounding the apartment is known for prostitutes and gang violence including armed conflicts, gun violence is frequent.
         """);
 
-var filterStrict = 
-    FilterConfig.create()
-        .type(FilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
-        .config(
-            AzureContentSafety.create()
-                .hate(NUMBER_0)
-                .selfHarm(NUMBER_0)
-                .sexual(NUMBER_0)
-                .violence(NUMBER_0));
-
-var filterLoose =
-    FilterConfig.create()
-        .type(FilterConfig.TypeEnum.AZURE_CONTENT_SAFETY)
-        .config(
-            AzureContentSafety.create()
-                .hate(NUMBER_4)
-                .selfHarm(NUMBER_4)
-                .sexual(NUMBER_4)
-                .violence(NUMBER_4));
-
-var filteringConfig =
-    FilteringModuleConfig.create()
-        // changing the input to filterLoose will allow the message to pass
-        .input(InputFilteringConfig.create().filters(filterStrict))
-        .output(OutputFilteringConfig.create().filters(filterStrict));
-
-var configWithFilter = config.withFilteringConfig(filteringConfig);
+var filterStrict = new AzureContentFilter()
+                .hate(ALLOW_SAFE)
+                .selfHarm(ALLOW_SAFE)
+                .sexual(ALLOW_SAFE)
+    .violence(ALLOW_SAFE);
+
+var filterLoose = new AzureContentFilter()
+                .hate(ALLOW_SAFE_LOW_MEDIUM)
+                .selfHarm(ALLOW_SAFE_LOW_MEDIUM)
+                .sexual(ALLOW_SAFE_LOW_MEDIUM)
+    .violence(ALLOW_SAFE_LOW_MEDIUM);
+
+// changing the input to filterLoose will allow the message to pass
+var configWithFilter = config.withInputFiltering(filterStrict).withOutputFiltering(filterStrict);
 
 // this fails with Bad Request because the strict filter prohibits the input message
 var result =
@@ -185,14 +171,8 @@ var result =
 Use the data masking module to anonymize personal information in the input:
 
 ```java
-var maskingProvider =
-    MaskingProviderConfig.create()
-        .type(MaskingProviderConfig.TypeEnum.SAP_DATA_PRIVACY_INTEGRATION)
-        .method(MaskingProviderConfig.MethodEnum.ANONYMIZATION)
-        .entities(
-            DPIEntityConfig.create().type(DPIEntities.PHONE),
-            DPIEntityConfig.create().type(DPIEntities.PERSON));
-var maskingConfig = MaskingModuleConfig.create().maskingProviders(maskingProvider);
+var maskingConfig =
+    DpiMasking.anonymization().withEntities(DPIEntities.PHONE, DPIEntities.PERSON);
 var configWithMasking = config.withMaskingConfig(maskingConfig);
 
 var systemMessage = ChatMessage.create()
@@ -211,20 +191,20 @@ var result =
     new OrchestrationClient().chatCompletion(prompt, configWithMasking);
 ```
 
-In this example, the input will be masked before the call to the LLM. Note that data cannot be unmasked in the LLM output.
+In this example, the input will be masked before the call to the LLM and will remain masked in the output.
 
 ### Set model parameters
 
-Change your LLM module configuration to add model parameters:
+Change your LLM configuration to add model parameters:
 
 ```java
-var llmConfig =
-    LLMModuleConfig.create()
-        .modelName("gpt-35-turbo")
-        .modelParams(
+OrchestrationAiModel customGPT4O =
+    OrchestrationAiModel.GPT_4O
+        .withParams(
             Map.of(
                 "max_tokens", 50,
                 "temperature", 0.1,
                 "frequency_penalty", 0,
-                "presence_penalty", 0));
+                "presence_penalty", 0))
+        .withVersion("2024-05-13");
 ```

foundation-models/openai/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.sap.ai.sdk</groupId>
     <artifactId>sdk-parent</artifactId>
-    <version>0.2.0-SNAPSHOT</version>
+    <version>0.3.0-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
   <groupId>com.sap.ai.sdk.foundationmodels</groupId>

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatCompletionOutput.java

@@ -40,9 +40,7 @@ public class OpenAiChatCompletionOutput extends OpenAiCompletionOutput
    */
   @Nonnull
   public String getContent() throws OpenAiClientException {
-    if (getChoices().isEmpty()) {
-      return "";
-    }
+    //    We expect choices to be defined and never empty.
     if ("content_filter".equals(getChoices().get(0).getFinishReason())) {
       throw new OpenAiClientException("Content filter filtered the output.");
     }

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatMessage.java

@@ -250,7 +250,7 @@ class OpenAiChatAssistantMessage implements OpenAiChatMessage {
     /** The tool calls generated by the model, such as function calls. */
     @JsonProperty("tool_calls")
     @Getter(onMethod_ = @Nullable)
-    private List<OpenAiChatToolCall> tool_calls;
+    private List<OpenAiChatToolCall> toolCalls;
 
     // TODO: add context
     // https://github.com/Azure/azure-rest-api-specs/blob/07d286359f828bbc7901e86288a5d62b48ae2052/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json#L1599
@@ -264,12 +264,11 @@ void addDelta(@Nonnull final OpenAiChatAssistantMessage delta) {
         content += delta.getContent();
       }
 
-      if (delta.getTool_calls() != null) {
-        if (tool_calls == null) {
-          tool_calls = new ArrayList<>();
+      if (delta.getToolCalls() != null) {
+        if (toolCalls == null) {
+          toolCalls = new ArrayList<>();
         }
-        // TODO: camel case
-        tool_calls.addAll(delta.getTool_calls());
+        toolCalls.addAll(delta.getToolCalls());
       }
     }
   }