Skip to content
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

[Doc] Add SAP Cloud SDK version requirements #160

Merged
merged 7 commits into from
Nov 25, 2024
+10 −4
Merged

[Doc] Add SAP Cloud SDK version requirements #160

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
abba9ad
Add version requirements
newtork Nov 14, 2024
73ec31e
format
newtork Nov 14, 2024
24201c3
Update pom.xml
newtork Nov 14, 2024
3de6f90
Update README.md
newtork Nov 15, 2024
f0dd5cd
Update README.md
newtork Nov 22, 2024
49b02c8
Merge branch 'main' into doc/cloud-sdk-requirements
newtork Nov 25, 2024
7ddc709
Update README.md
newtork Nov 25, 2024
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
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,21 @@ The SDK simplifies the setup and interaction with SAP AI Core, allowing you to f

## General Requirements

To use the SAP AI SDK for Java, the following general prerequisites must be met:
To use the SDK in a Java application, it is necessary to understand the technical prerequisites and required versions for common dependencies.

- **Java Development Kit (JDK) 17** or higher installed.
- **Apache Maven 3.9** or higher installed.
- **SAP AI Core Service** enabled in your SAP BTP account.
- [How to enable the AI Core service](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup)
- **SAP AI Core Credentials** to access the AI Core service.
- [Connecting to SAP AI Core](#connecting-to-sap-ai-core)
- **(Optional) Spring Boot** version 3 or higher if you are using Spring Boot.

The following table lists the required versions, based on the latest release:

| 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 |

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

Expand Down