@sap-ai-sdk/orchestration 1.9.1-20250319013141.0 → 1.10.1-20250320013136.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -20
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -9,7 +9,6 @@ This package incorporates generative AI orchestration capabilities into your AI
9
9
  - [Installation](#installation)
10
10
  - [Prerequisites](#prerequisites)
11
11
  - [Orchestration Service](#orchestration-service)
12
- - [Relationship between Orchestration and Resource Groups](#relationship-between-orchestration-and-resource-groups)
13
12
  - [Usage](#usage)
14
13
  - [LLM Config](#llm-config)
15
14
  - [Templating](#templating)
@@ -19,7 +18,7 @@ This package incorporates generative AI orchestration capabilities into your AI
19
18
  - [Grounding](#grounding)
20
19
  - [Using a JSON Configuration from AI Launchpad](#using-a-json-configuration-from-ai-launchpad)
21
20
  - [Streaming](#streaming)
22
- - [Using Resource Groups](#using-resource-groups)
21
+ - [Using a Custom Resource Group](#using-a-custom-resource-group)
23
22
  - [Custom Request Configuration](#custom-request-configuration)
24
23
  - [Custom Destination](#custom-destination)
25
24
  - [Error Handling](#error-handling)
@@ -37,10 +36,10 @@ $ npm install @sap-ai-sdk/orchestration
37
36
 
38
37
  - [Enable the AI Core service in SAP BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
39
38
  - Configure the project with **Node.js v20 or higher** and **native ESM** support.
40
- - Ensure an [orchestration deployment is available in the SAP Generative AI Hub](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-orchestration).
41
- - Use the [`DeploymentApi`](https://github.com/SAP/ai-sdk-js/blob/main/packages/ai-api/README.md#create-a-deployment) from `@sap-ai-sdk/ai-api` [to create a deployment](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-orchestration).
42
- Alternatively, you can also create deployments using the [SAP AI Launchpad](https://help.sap.com/docs/sap-ai-core/generative-ai-hub/activate-generative-ai-hub-for-sap-ai-launchpad?locale=en-US&q=launchpad).
43
- - Once the deployment is complete, access the orchestration service via the `deploymentUrl`.
39
+ - An [Orchestration deployment](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/get-your-orchestration-deployment-url) is running in your AI Core service instance.
40
+ - When using the `default` [resource group](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/resource-groups), a deployment is provided by default.
41
+ No further setup is needed.
42
+ - When using a custom resource group, please refer to [this guide](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-orchestration) on how to create a deployment in that resource group.
44
43
 
45
44
  > **Accessing the AI Core Service via the SDK**
46
45
  >
@@ -55,16 +54,6 @@ The orchestration service provides essential features like [templating](#templat
55
54
 
56
55
  Find more details about orchestration workflow [here](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/orchestration-workflow).
57
56
 
58
- ## Relationship between Orchestration and Resource Groups
59
-
60
- SAP AI Core manages access to orchestration of generative AI models through the global AI scenario `orchestration`.
61
- Creating a deployment for enabling orchestration capabilities requires access to this scenario.
62
-
63
- [Resource groups](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/resource-groups?q=resource+group) represent a virtual collection of related resources within the scope of one SAP AI Core tenant.
64
- Each resource group allows for a one-time orchestration deployment.
65
-
66
- Consequently, each orchestration deployment uniquely maps to a resource group within the `orchestration` scenario.
67
-
68
57
  ## Usage
69
58
 
70
59
  Leverage the orchestration service capabilities by using the orchestration client.
@@ -652,9 +641,12 @@ If you don't want any streaming options as part of your call to the LLM, set `st
652
641
  > [!NOTE]
653
642
  > When initalizing a client with a JSON module config, providing streaming options is not possible.
654
643
 
655
- ### Using Resource Groups
644
+ ### Using a Custom Resource Group
645
+
646
+ Using a custom [resource group](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/resource-groups) requires a deployment of Orchestration within that resource group.
647
+ Refer to [this guide](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-orchestration) for creating such a deployment.
656
648
 
657
- The resource group can be used as an additional parameter to pick the right orchestration deployment.
649
+ You can pass a custom resource group when creating a client as follows:
658
650
 
659
651
  ```ts
660
652
  const orchestrationClient = new OrchestrationClient(
@@ -671,8 +663,6 @@ const orchestrationClient = new OrchestrationClient(
671
663
  );
672
664
  ```
673
665
 
674
- The relationship between orchestration and resource groups is explained [here](#relationship-between-orchestration-and-resource-groups).
675
-
676
666
  ### Custom Request Configuration
677
667
 
678
668
  Set custom request configuration in the `requestConfig` parameter when calling the `chatCompletion()` method.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap-ai-sdk/orchestration",
3
- "version": "1.9.1-20250319013141.0",
3
+ "version": "1.10.1-20250320013136.0",
4
4
  "description": "",
5
5
  "license": "Apache-2.0",
6
6
  "keywords": [
@@ -20,13 +20,13 @@
20
20
  "internal.d.ts"
21
21
  ],
22
22
  "dependencies": {
23
- "@sap-cloud-sdk/util": "^4.0.1",
24
- "@sap-ai-sdk/core": "^1.9.1-20250319013141.0",
25
- "@sap-ai-sdk/ai-api": "^1.9.1-20250319013141.0"
23
+ "@sap-cloud-sdk/util": "^4.0.2",
24
+ "@sap-ai-sdk/core": "^1.10.1-20250320013136.0",
25
+ "@sap-ai-sdk/ai-api": "^1.10.1-20250320013136.0"
26
26
  },
27
27
  "devDependencies": {
28
- "@sap-cloud-sdk/http-client": "^4.0.1",
29
- "@sap-cloud-sdk/connectivity": "^4.0.1"
28
+ "@sap-cloud-sdk/http-client": "^4.0.2",
29
+ "@sap-cloud-sdk/connectivity": "^4.0.2"
30
30
  },
31
31
  "scripts": {
32
32
  "compile": "tsc",