Skip to content

Commit fdb30da

Browse files
fix: Update docs (#347)
* Update docs * Update release_notes.md * Update release_notes.md * Fix FOSSTARS badge
1 parent 0c75937 commit fdb30da

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![build](https://github.com/SAP/ai-sdk-java/actions/workflows/continuous-integration.yaml/badge.svg?branch=main)
22
![CodeQL](https://github.com/SAP/ai-sdk-java/actions/workflows/github-code-scanning/codeql/badge.svg)
33
[![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)
4-
[![Fosstars security rating](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_badge.svg)](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_report.md)
4+
[![Fosstars security rating](https://github.com/SAP/ai-sdk-java/actions/workflows/fosstars-report.yml/badge.svg?branch=main)](https://github.com/SAP/ai-sdk-java/blob/fosstars-report/fosstars_report.md)
55

66
# <img src="https://sap.github.io/cloud-sdk/img/logo.svg" alt="SAP Cloud SDK" width="30"/> SAP Cloud SDK for AI (for Java)
77

docs/guides/SPRING_AI_INTEGRATION.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,11 @@ First, add the Spring AI dependency to your `pom.xml`:
3232
</repository>
3333
```
3434

35-
:::note Spring AI Milestone Version
36-
Note that currently no stable version of Spring AI exists just yet.
37-
The AI SDK currently uses the [M6 milestone](https://spring.io/blog/2025/02/14/spring-ai-1-0-0-m6-released).
38-
39-
Please be aware that future versions of the AI SDK may increase the Spring AI version.
40-
:::
35+
> [!NOTE]
36+
> Note that currently no stable version of Spring AI exists just yet.
37+
> The AI SDK currently uses the [M6 milestone](https://spring.io/blog/2025/02/14/spring-ai-1-0-0-m6-released).
38+
>
39+
> Please be aware that future versions of the AI SDK may increase the Spring AI version.
4140
4241
## Orchestration Chat Completion
4342

docs/release-notes/release_notes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
### 🔧 Compatibility Notes
1010

1111
- The constructors `UserMessage(MessageContent)` and `SystemMessage(MessageContent)` are removed. Use `Message.user(String)`, `Message.user(ImageItem)`, or `Message.system(String)` instead.
12+
- Deprecate `getCustomField(String)` in favor of `toMap()` on generated model classes.
13+
- `com.sap.ai.sdk.core.model.*`
14+
- `com.sap.ai.sdk.orchestration.model.*`
1215

1316
### ✨ New Functionality
1417

0 commit comments

Comments
 (0)