Skip to content

Commit

Permalink
chore: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MatKuhr committed Jan 9, 2025
1 parent 4aecbbf commit 726d4d4
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ The following table lists the required versions, based on the latest release:

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

> [!WARNING]
> All classes under any of the `...model` packages are generated from an OpenAPI specification and marked as `@Beta`.
> This means that these model classes are not guaranteed to be stable and may change with future releases.
> They are safe to use, but may require updates even in minor releases.
## Getting Started

### What You'll Build
Expand Down Expand Up @@ -130,6 +135,8 @@ For more detailed information and advanced usage, please refer to the following:
- [OpenAI Chat Completion](docs/guides/OPENAI_CHAT_COMPLETION.md)
- [AI Core Deployment](docs/guides/AI_CORE_DEPLOYMENT.md)

For updating versions, please refer to the [**Release Notes**](docs/release-notes/release-notes-0-to-14.md).

## FAQs

### _"How to add a custom header to AI Core requests?"_
Expand Down
4 changes: 4 additions & 0 deletions docs/guides/AI_CORE_DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@

This guide provides examples on how to create and manage deployments in SAP AI Core using the SAP AI SDK for Java.

> [!WARNING]
> The below examples rely on generated model classes.
> Please be aware of the [implications described here](/README.md#general-requirements).
## Prerequisites

Before using the AI Core module, ensure that you have met all the general requirements outlined in the [README.md](../../README.md#general-requirements).
Expand Down
6 changes: 5 additions & 1 deletion docs/guides/CONNECTING_TO_AICORE.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,18 @@ You can define a destination in the BTP Destination Service and use that to conn
- **Client ID**: `[clientid]`
- **Client Secret**: `[clientsecret]`
- **Token Service URL Type**: `Dedicated`
- **Token Service URL**: `[url]`
- **Token Service URL**: `[url]/oauth/token`
Fill in the values for URL, client ID, client secret, and token service URL from the service key JSON.
Make sure to add `/oauth/token` in the token service URL.
</details>
To use the destination, ensure you have created an instance of the BTP Destination Service and bound it to your application.
> [!Tip]
> If you are using CAP, you can again use Hybrid Testing to bind the destination service to your application when running **locally**.
```java
Destination destination = DestinationAccessor.getDestination("my-aicore").asHttp();
AiCoreService aiCoreService = new AiCoreService().withBaseDestination(destination);
Expand Down

0 comments on commit 726d4d4

Please sign in to comment.