Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ Please provide a short description of what your change does and why it is needed
- [ ] Tests cover the scope above
- [ ] Error handling created / updated & covered by the tests above
- [ ] ~Aligned changes with the JavaScript SDK~
- [ ] Documentation updated
- [ ] [Documentation](https://github.com/SAP/ai-sdk/tree/main/docs-java) updated
- [ ] Release notes updated
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To use the SDK in a Java application, it is necessary to understand the technica
- Java 17 or higher.
- Access to an **SAP AI Core Service** instance.

Please refer to [this documentation on **how to connect the SDK to AI Core**](docs/guides/CONNECTING_TO_AICORE.md).
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).

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

Expand Down Expand Up @@ -119,26 +119,26 @@ export AICORE_SERVICE_KEY='{ "clientid": "...", "clientsecret": "...", "url": ".
mvn spring-boot:run
```

Please find **detailed instructions** and more examples [in this documentation](docs/guides/CONNECTING_TO_AICORE.md#using-the-aicore_service_key-environment-variable).
Please find **detailed instructions** and more examples [in this documentation](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core#using-the-aicore_service_key-environment-variable).

### Explore Further Capabilities

Check out the options available for the `OrchestrationPrompt` and `OrchestrationModuleConfig` classes.
You can use templating, content filtering, data masking and more.
Please refer to [this documentation](docs/guides/ORCHESTRATION_CHAT_COMPLETION.md) for more information.
Please refer to [this documentation](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion) for more information.

## Documentation

For more detailed information and advanced usage, please refer to the following:

- [<img src="sample-code/spring-app/src/main/resources/static/BTP-Cockpit-Logo.png"/> Connecting to AI Core](docs/guides/CONNECTING_TO_AICORE.md)
- [<img src="sample-code/spring-app/src/main/resources/static/Orchestration-Logo.png" width="16"/> Orchestration Chat Completion](docs/guides/ORCHESTRATION_CHAT_COMPLETION.md)
- [<img src="sample-code/spring-app/src/main/resources/static/Open-AI-Logo.svg" width="16"/> OpenAI Chat Completion](docs/guides/OPENAI_CHAT_COMPLETION.md)
- [<img src="https://spring.io/favicon-32x32.png" width="16"/> Spring AI Integration](docs/guides/SPRING_AI_INTEGRATION.md)
- [🧰 AI Core Deployment](docs/guides/AI_CORE_DEPLOYMENT.md)
- [<img src="sample-code/spring-app/src/main/resources/static/grounding.png" width="16"/> AI Core Grounding](docs/guides/GROUNDING.md)
- [<img src="sample-code/spring-app/src/main/resources/static/BTP-Cockpit-Logo.png"/> Connecting to AI Core](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core)
- [<img src="sample-code/spring-app/src/main/resources/static/Orchestration-Logo.png" width="16"/> Orchestration Chat Completion](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion)
- [<img src="sample-code/spring-app/src/main/resources/static/Open-AI-Logo.svg" width="16"/> OpenAI Chat Completion](https://sap.github.io/ai-sdk/docs/java/guides/openai-chat-completion)
- [<img src="https://spring.io/favicon-32x32.png" width="16"/> Spring AI Integration](https://sap.github.io/ai-sdk/docs/java/guides/spring-ai-integration)
- [🧰 AI Core Deployment](https://sap.github.io/ai-sdk/docs/java/guides/ai-core-deployment)
- [<img src="sample-code/spring-app/src/main/resources/static/grounding.png" width="16"/> AI Core Grounding](https://sap.github.io/ai-sdk/docs/java/guides/document-grounding)

For updating versions, please refer to the [**Release Notes**](docs/release-notes/release-notes-0-to-14.md).
For updating versions, please refer to the [**Release Notes**](https://sap.github.io/ai-sdk/docs/java/release-notes).

## Build the Project

Expand Down Expand Up @@ -177,7 +177,7 @@ OrchestrationClient client = new OrchestrationClient(destination);
OpenAiClient client2 = OpenAiClient.withCustomDestination(destination);
```

For more information, please refer to the [AI Core connectivity guide](./docs/guides/CONNECTING_TO_AICORE.md) and the [SAP Cloud SDK documentation](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations).
For more information, please refer to the [AI Core connectivity guide](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core) and the [SAP Cloud SDK documentation](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations).

### _"There's a vulnerability warning `CVE-2021-41251`?"_

Expand Down
6 changes: 3 additions & 3 deletions docs/blog/Introducing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ String id = deployment.getId();
AiExecutionStatus status = deployment.getStatus();
```

You can learn more about the SDK's capabilities for SAP AI Core [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/AI_CORE_DEPLOYMENT.md).
You can learn more about the SDK's capabilities for SAP AI Core [in this guide](https://sap.github.io/ai-sdk/docs/java/guides/ai-core-deployment).

## AI Core - Orchestration

Expand Down Expand Up @@ -72,7 +72,7 @@ var result = client.chatCompletion(prompt, config);
String messageResult = result.getContent();
```

You can learn more about the SDK's capabilities for Orchestration Service [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/ORCHESTRATION_CHAT_COMPLETION.md).
You can learn more about the SDK's capabilities for Orchestration Service [in this guide](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion).

## AI Core - Foundation Models

Expand Down Expand Up @@ -101,7 +101,7 @@ var result =
String resultMessage = result.getContent();
```

You can learn more about the SDK's capabilities for foundation models and OpenAI specific features [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/OPENAI_CHAT_COMPLETION.md).
You can learn more about the SDK's capabilities for foundation models and OpenAI specific features [this guide](https://sap.github.io/ai-sdk/docs/java/guides/openai-chat-completion).

## Getting Started

Expand Down
108 changes: 0 additions & 108 deletions docs/guides/AI_CORE_DEPLOYMENT.md

This file was deleted.

175 changes: 0 additions & 175 deletions docs/guides/CONNECTING_TO_AICORE.md

This file was deleted.

Loading