Merge branch 'main' into orchestration-streaming

Author: CharlesDuboisSAP

.github/workflows/fosstars-report.yml

@@ -31,19 +31,13 @@ jobs:
         with:
           path: ${{ env.CVE_CACHE_DIR }}
           key: ${{ env.CVE_CACHE_KEY }}
-          fail-on-cache-miss: true
+         # fail-on-cache-miss: true
 
       - name: "Build SDK"
         run: |
           MVN_ARGS="${{ env.MVN_MULTI_THREADED_ARGS }} clean install -DskipTests -DskipFormatting"
           mvn $MVN_ARGS
 
-      - name: "Fosstars Rating"
-        uses: SAP/[email protected]
-        with:
-          report-branch: fosstars-report
-          token: ${{ secrets.GITHUB_TOKEN }}
-
       - name: "CVE Scan"
         env:
           NVD_API_KEY: ${{ secrets.NVD_API_KEY }}
@@ -73,6 +67,13 @@ jobs:
           path: ${{ env.CVE_CACHE_DIR }}
           key: ${{ env.CVE_CACHE_KEY }}
 
+      # This action changes the active branch!
+      - name: "Fosstars Rating"
+        uses: SAP/[email protected]
+        with:
+          report-branch: fosstars-report
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: "Slack Notification"
         if: failure()
         uses: slackapi/[email protected]

.pipeline/scripts/release_notes_automation.py

@@ -69,10 +69,10 @@ def count_releases(filename):
     return count
 
 def find_target_file(version):
-    # release-notes-X-to-Y.mdx with every 15 versions the index increases by 15 and stays the same for 15 versions
+    # release-notes-X-to-Y.md with every 15 versions the index increases by 15 and stays the same for 15 versions
     minor_version = int(version.split(".")[1])
     index = minor_version // 15 * 15
-    return "release-notes-" + str(index) + "-to-" + str(index + 14) + ".mdx"
+    return "release-notes-" + str(index) + "-to-" + str(index + 14) + ".md"
 
 def write_release_notes(folder, target_file):
     absolute_target_file = os.path.join(folder, target_file)

.pipeline/scripts/release_notes_template.md

@@ -20,4 +20,4 @@
 
 ### 🐛 Fixed Issues
 
-- 
+- 

docs/guides/OPENAI_CHAT_COMPLETION.md

@@ -200,3 +200,15 @@ System.out.println("Tokens used: " + tokensUsed);
 
 Please find [an example in our Spring Boot application](../../sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/OpenAiController.java). It shows the usage of Spring
 Boot's `ResponseBodyEmitter` to stream the chat completion delta messages to the frontend in real-time.
+
+### Embedding
+
+Get the embeddings of a text input in list of float values:
+
+```java
+OpenAiEmbeddingParameters request = new OpenAiEmbeddingParameters().setInput("Hello World");
+
+OpenAiEmbeddingOutput embedding = OpenAiClient.forModel(TEXT_EMBEDDING_ADA_002).embedding(request);
+```
+
+See [an example in our Spring Boot application](../../sample-code/spring-app/src/main/java/com/sap/ai/sdk/app/controllers/OpenAiController.java)

docs/release-notes/release-notes-0-to-14.md

@@ -0,0 +1,26 @@
+## 1.0.0 - December 03, 2024
+
+[All Release Changes](https://github.com/SAP/ai-sdk-java/releases/tag/rel%2F1.0.0)
+
+### ✨ New Functionality
+
+- Introduce AI Core client to consume the [AI Core Rest APIs](https://api.sap.com/api/AI_CORE_API/overview).
+  Here are a few features:
+  - Artifact management: register and organize datasets and model artifacts.
+  - Configuration management: set up configurations for various models and use cases.
+  - Deployment management: deploy AI models and manage their lifecycle within SAP AI Core.
+- Introduce Orchestration client for consuming the following features of the orchestration service:
+  - Harmonized LLM access via orchestration
+  - Prompt templates
+  - Content filtering
+  - Masking
+- Introduce the OpenAI client to consume the following features:
+  - Chat completion and streaming chat completion
+    - Text
+    - Images
+    - Tools
+  - Generate embeddings for input text.
+
+> [!WARNING]  
+> All model classes are generated or depend on changing specifications.
+> This means that model classes are not stable and may change in the future.

docs/release-notes/release-notes-0-to-14.mdx

@@ -112,7 +112,7 @@
       <dependency>
         <groupId>com.fasterxml.jackson.module</groupId>
         <artifactId>jackson-module-parameter-names</artifactId>
-        <version>2.18.1</version>
+        <version>2.18.2</version>
       </dependency>
       <!-- scope "test" -->
       <dependency>
@@ -589,14 +589,12 @@ https://gitbox.apache.org/repos/asf?p=maven-pmd-plugin.git;a=blob_plain;f=src/ma
       <plugin>
         <groupId>org.owasp</groupId>
         <artifactId>dependency-check-maven</artifactId>
-        <version>11.1.0</version>
+        <version>11.1.1</version>
         <configuration>
           <connectionTimeout>60000</connectionTimeout>
           <nvdMaxRetryCount>20</nvdMaxRetryCount>
           <failBuildOnCVSS>7</failBuildOnCVSS>
-          <!-- Using the https://mirror.cveb.in mirror because NVD is too slow.
-           For more information see this discussion: https://github.com/jeremylong/DependencyCheck/issues/7180#issuecomment-2500914164 -->
-          <nvdDatafeedUrl>https://mirror.cveb.in/nvd/json/cve/1.1/nvdcve-1.1-{0}.json.gz</nvdDatafeedUrl>
+          <nvdApiKeyEnvironmentVariable>NVD_API_KEY</nvdApiKeyEnvironmentVariable>
           <suppressionFile>${project.rootdir}/.pipeline/dependency-check-suppression.xml</suppressionFile>
           <nvdValidForHours>46</nvdValidForHours>
           <skipProvidedScope>true</skipProvidedScope>
@@ -716,7 +714,7 @@ https://gitbox.apache.org/repos/asf?p=maven-pmd-plugin.git;a=blob_plain;f=src/ma
             <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-javadoc-plugin</artifactId>
-              <version>3.11.1</version>
+              <version>3.11.2</version>
               <configuration>
                 <quiet>true</quiet>
                 <additionalOptions>-Xdoclint:none</additionalOptions>