Skip to content

docs: Clarify optionality of frameworks in README #576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CharlesDuboisSAP merged 2 commits into from
Sep 25, 2025
+15 −13
Merged

docs: Clarify optionality of frameworks in README #576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cd6100
Readme update
rpanackal Sep 10, 2025
927cd9a
fix unintended formatting changes
rpanackal Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,26 @@ The SDK simplifies the setup and interaction with SAP AI Core, allowing you to f

## General Requirements

To use the SDK in a Java application, it is necessary to understand the technical prerequisites and required versions for common dependencies.
#### Development Environment

- Java 17 or higher.
- Access to an **SAP AI Core Service** instance.
These are required on the developer side to build and run applications with the SDK:

Please refer to [this documentation on **how to connect the SDK to AI Core**](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core).
* **Java JDK**: 17 or higher (21 LTS recommended).
* **SAP Cloud SDK**: 5.6.0 or later (latest recommended, added as a Maven dependency).

The following table lists the required versions, based on the latest release:
#### SAP AI Core Service instance

| Dependency | Minimum Version | Recommended Version |
|------------------------|-----------------|---------------------|
| JDK | 17 (LTS) | 21 (LTS) |
| SAP Cloud SDK | 5.6.0 | latest |
| (optional) CAP Java | 3.0.0 | latest |
| (optional) Spring Boot | 3.0 | latest |
| (optional) Spring AI | 1.0.0 | latest |
To make of use the services supported by the SDK, you need to have access to an SAP AI Core Service instance. Checkout [how to connect](link).

See [an example `pom.xml` in our Spring Boot application](sample-code/spring-app/pom.xml).
#### Optional Integrations

The SDK can be combined with popular Java frameworks. These are not required for core functionality, but version compatibility is listed for reference:

* **Spring AI** ≥ 1.0.0
* **Spring Boot** ≥ 3.0
* **CAP Java** ≥ 3.0.0

👉 See an [example `pom.xml`](link) in our sample Spring Boot application.

> [!WARNING]
> All classes under any of the `...model` packages are generated from an OpenAPI specification and marked as `@Beta`.
Expand Down
Loading