Skip to content

Commit 4cd6100

Browse files
committed
Readme update
1 parent 974375a commit 4cd6100

File tree

1 file changed

+29
-24
lines changed

1 file changed

+29
-24
lines changed

README.md

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,26 @@ The SDK simplifies the setup and interaction with SAP AI Core, allowing you to f
3030

3131
## General Requirements
3232

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

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

38-
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).
37+
* **Java JDK**: 17 or higher (21 LTS recommended).
38+
* **SAP Cloud SDK**: 5.6.0 or later (latest recommended, added as a Maven dependency).
3939

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

42-
| Dependency | Minimum Version | Recommended Version |
43-
|------------------------|-----------------|---------------------|
44-
| JDK | 17 (LTS) | 21 (LTS) |
45-
| SAP Cloud SDK | 5.6.0 | latest |
46-
| (optional) CAP Java | 3.0.0 | latest |
47-
| (optional) Spring Boot | 3.0 | latest |
48-
| (optional) Spring AI | 1.0.0 | latest |
42+
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).
4943

50-
See [an example `pom.xml` in our Spring Boot application](sample-code/spring-app/pom.xml).
44+
#### Optional Integrations
45+
46+
The SDK can be combined with popular Java frameworks. These are not required for core functionality, but version compatibility is listed for reference:
47+
48+
* **Spring AI** ≥ 1.0.0
49+
* **Spring Boot** ≥ 3.0
50+
* **CAP Java** ≥ 3.0.0
51+
52+
👉 See an [example `pom.xml`](link) in our sample Spring Boot application.
5153

5254
> [!WARNING]
5355
> All classes under any of the `...model` packages are generated from an OpenAPI specification and marked as `@Beta`.
@@ -71,11 +73,12 @@ If you don't have a deployment yet, please refer to [this guide](https://help.sa
7173
Add the following dependency to your `pom.xml` file:
7274

7375
```xml
76+
7477
<dependency>
75-
<groupId>com.sap.ai.sdk</groupId>
76-
<artifactId>orchestration</artifactId>
77-
<!-- Use the latest version here -->
78-
<version>${ai-sdk.version}</version>
78+
<groupId>com.sap.ai.sdk</groupId>
79+
<artifactId>orchestration</artifactId>
80+
<!-- Use the latest version here -->
81+
<version>${ai-sdk.version}</version>
7982
</dependency>
8083
```
8184

@@ -91,7 +94,7 @@ Next, we'll specify the model we want to use:
9194

9295
```java
9396
var config = new OrchestrationModuleConfig()
94-
.withLlmConfig(OrchestrationAiModel.GPT_4O);
97+
.withLlmConfig(OrchestrationAiModel.GPT_4O);
9598
```
9699

97100
Now we can create our first prompt:
@@ -169,7 +172,10 @@ var destination =
169172
.build();
170173

171174
// AI Core client
172-
service = service.withBaseDestination(destination);
175+
service =service.
176+
177+
withBaseDestination(destination);
178+
173179
DeploymentApi client = new DeploymentApi(service);
174180
```
175181

@@ -191,7 +197,6 @@ This is a known false-positive finding.
191197
Depending on the tooling any product called "SAP Cloud SDK" or similar with a low version number may be marked as vulnerable, incorrectly.
192198
Please consider suppressing the warning, [as we do](https://github.com/SAP/ai-sdk-java/blob/main/.pipeline/dependency-check-suppression.xml).
193199

194-
195200
### _"Are there any example projects?"_
196201

197202
Explore example applications and code snippets:
@@ -201,20 +206,20 @@ Explore example applications and code snippets:
201206
## Contribute, Support and Feedback
202207

203208
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/ai-sdk-java/issues).
204-
Contribution and feedback are encouraged and always welcome.
209+
Contribution and feedback are encouraged and always welcome.
205210
For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
206211

207212
## Security / Disclosure
208213

209-
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/ai-sdk-java/security/policy) on how to report it.
214+
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/ai-sdk-java/security/policy) on how to report it.
210215
Please do not create GitHub issues for security-related doubts or problems.
211216

212217
## Code of Conduct
213218

214-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.
219+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.
215220
By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
216221

217222
## Licensing
218223

219-
Copyright 2024 SAP SE or an SAP affiliate company and ai-sdk-java contributors. Please see our [LICENSE](LICENSE) for copyright and license information.
224+
Copyright 2024 SAP SE or an SAP affiliate company and ai-sdk-java contributors. Please see our [LICENSE](LICENSE) for copyright and license information.
220225
Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/ai-sdk-java).

0 commit comments

Comments
 (0)