@sap-ai-sdk/ai-api 1.11.1-20250414013204.0 → 1.11.1-20250415013200.0

package/README.md

@@ -14,16 +14,7 @@ We maintain a list of [currently available and tested AI Core APIs](https://gith
 ### Table of Contents
 
 - [Installation](#installation)
-- [Version Management](#version-management)
-- [Prerequisites](#prerequisites)
-- [Usage](#usage)
-  - [Create an Artifact](#create-an-artifact)
-  - [Create a Configuration](#create-a-configuration)
-  - [Create a Deployment](#create-a-deployment)
-  - [Delete a Deployment](#delete-a-deployment)
-  - [Custom Destination](#custom-destination)
-- [Error Handling](#error-handling)
-- [Local Testing](#local-testing)
+- [Documentation](#documentation)
 - [Support, Feedback, Contribution](#support-feedback-contribution)
 - [License](#license)
 
@@ -33,156 +24,9 @@ We maintain a list of [currently available and tested AI Core APIs](https://gith
 $ npm install @sap-ai-sdk/ai-api
 ```
 
-## Version Management
+## Documentation
 
-⚠️ **Important**: This package contains generated code.
-Updates to this package may include breaking changes.
-
-To ensure compatibility and manage updates effectively, we strongly recommend using the tilde (`~`) version range in your project instead of the caret (`^`). This approach will allow patch-level updates while preventing potentially breaking minor version changes.
-
-```JSON
-"dependencies": {
-    "@sap-ai-sdk/ai-api": "~1.0.0"
-}
-```
-
-## Prerequisites
-
-- [Enable the AI Core service in SAP BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
-- Configure the project with **Node.js v20 or higher** and **native ESM** support.
-
-> **Accessing the AI Core Service via the SDK**
->
-> The SDK automatically retrieves the `AI Core` service credentials and resolves the access token needed for authentication.
->
-> - In Cloud Foundry, it's accessed from the `VCAP_SERVICES` environment variable.
-> - In Kubernetes / Kyma environments, you have to mount the service binding as a secret instead, for more information refer to [this documentation](https://www.npmjs.com/package/@sap/xsenv#usage-in-kubernetes).
-
-## Usage
-
-The examples below demonstrate the usage of the most commonly used APIs in SAP AI Core.
-In addition to the examples below, you can find more **sample code** [here](https://github.com/SAP/ai-sdk-js/blob/main/sample-code/src/ai-api).
-
-### Create an Artifact
-
-```ts
-async function createArtifact() {
-  const requestBody: ArtifactPostData = {
-    name: 'training-test-dataset',
-    kind: 'dataset',
-    url: 'https://ai.example.com',
-    scenarioId: 'foundation-models'
-  };
-
-  const responseData: ArtifactCreationResponse =
-    await ArtifactApi.artifactCreate(requestBody, {
-      'AI-Resource-Group': 'default'
-    }).execute();
-  return responseData;
-}
-```
-
-### Create a Configuration
-
-```ts
-async function createConfiguration() {
-  const requestBody: ConfigurationBaseData = {
-    name: 'gpt-4o',
-    executableId: 'azure-openai',
-    scenarioId: 'foundation-models',
-    parameterBindings: [
-      {
-        key: 'modelName',
-        value: 'gpt-4o'
-      },
-      {
-        key: 'modelVersion',
-        value: 'latest'
-      }
-    ],
-    inputArtifactBindings: []
-  };
-
-  const responseData: ConfigurationCreationResponse =
-    await ConfigurationApi.configurationCreate(requestBody, {
-      'AI-Resource-Group': 'default'
-    }).execute();
-  return responseData;
-}
-```
-
-### Create a Deployment
-
-```ts
-async function createDeployment() {
-  const requestBody: DeploymentCreationRequest = {
-    configurationId: '0a1b2c3d-4e5f6g7h'
-  };
-  const responseData: DeploymentCreationResponse =
-    await DeploymentApi.deploymentCreate(requestBody, {
-      'AI-Resource-Group': 'default'
-    }).execute();
-  return responseData;
-}
-```
-
-### Delete a Deployment
-
-Only deployments with `targetStatus: STOPPED` can be deleted.
-Thus, a modification request must be sent before deletion can occur.
-
-```ts
-async function modifyDeployment() {
-  let deploymentId: string = '0a1b2c3d4e5f';
-
-  const deployment: DeploymentResponseWithDetails =
-    await DeploymentApi.deploymentGet(
-      deploymentId,
-      {},
-      { 'AI-Resource-Group': 'default' }
-    ).execute();
-
-  if (deployment.targetStatus === 'RUNNING') {
-    // Only RUNNING deployments can be STOPPED.
-    const requestBody: DeploymentModificationRequest = {
-      targetStatus: 'STOPPED'
-    };
-
-    await DeploymentApi.deploymentModify(deploymentId, requestBody, {
-      'AI-Resource-Group': 'default'
-    }).execute();
-  }
-  // Wait a few seconds for the deployment to stop
-  return DeploymentApi.deploymentDelete(deploymentId, {
-    'AI-Resource-Group': 'default'
-  }).execute();
-}
-```
-
-### Custom Destination
-
-When calling the `execute()` method, it is possible to provide a custom destination.
-For example, when querying deployments targeting a destination with the name `my-destination`, the following code can be used:
-
-```ts
-const queryParams = status ? { status } : {};
-return DeploymentApi.deploymentQuery(queryParams, {
-  'AI-Resource-Group': resourceGroup
-}).execute({
-  destinationName: 'my-destination'
-});
-```
-
-By default, the fetched destination is cached.
-To disable caching, set the `useCache` parameter to `false` together with the `destinationName` parameter.
-
-## Error Handling
-
-For error handling instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#error-handling).
-
-## Local Testing
-
-For local testing instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#local-testing).
+Visit the [SAP Cloud SDK for AI (JavaScript)](https://sap.github.io/ai-sdk/docs/js/overview-cloud-sdk-for-ai-js) documentation portal to learn more about its capabilities and detailed usage.
 
 ## Support, Feedback, Contribution
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ai-sdk/ai-api",
-  "version": "1.11.1-20250414013204.0",
+  "version": "1.11.1-20250415013200.0",
   "description": "",
   "license": "Apache-2.0",
   "keywords": [
@@ -21,7 +21,7 @@
   "dependencies": {
     "@sap-cloud-sdk/connectivity": "^4.0.2",
     "@sap-cloud-sdk/util": "^4.0.2",
-    "@sap-ai-sdk/core": "^1.11.1-20250414013204.0"
+    "@sap-ai-sdk/core": "^1.11.1-20250415013200.0"
   },
   "scripts": {
     "compile": "tsc",