@sap-ai-sdk/foundation-models 1.1.1-20241011013059.0 → 1.1.1-20241012013050.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 -7
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -4,13 +4,14 @@ This package incorporates generative AI foundation models into your AI activitie
4
4
 
5
5
  ## Table of Contents
6
6
 
7
+ - [Table of Contents](#table-of-contents)
7
8
  - [Installation](#installation)
8
9
  - [Prerequisites](#prerequisites)
9
10
  - [Relationship between Models and Deployment ID](#relationship-between-models-and-deployment-id)
10
11
  - [Usage](#usage)
11
- - [Azure OpenAI Client Initialization](#client-initialization)
12
- - [Azure OpenAI Chat Client](#chat-client)
13
- - [Azure OpenAI Embedding Client](#embedding-client)
12
+ - [Azure OpenAI Client Initialization](#azure-openai-client-initialization)
13
+ - [Azure OpenAI Chat Client](#azure-openai-chat-client)
14
+ - [Azure OpenAI Embedding Client](#azure-openai-embedding-client)
14
15
  - [Custom Request Configuration](#custom-request-configuration)
15
16
  - [Local Testing](#local-testing)
16
17
  - [Support, Feedback, Contribution](#support-feedback-contribution)
@@ -24,7 +25,7 @@ $ npm install @sap-ai-sdk/foundation-models
24
25
 
25
26
  ## Prerequisites
26
27
 
27
- - [Enable the AI Core service in BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
28
+ - [Enable the AI Core service in SAP BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
28
29
  - Project configured with Node.js v20 or higher and native ESM support enabled.
29
30
  - A deployed OpenAI model in SAP Generative AI hub.
30
31
  - 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 deploy a model to SAP generative AI hub.
@@ -38,7 +39,8 @@ SAP AI Core manages access to generative AI models through the global AI scenari
38
39
  Creating a deployment for a model requires access to this scenario.
39
40
 
40
41
  Each model, model version, and resource group allows for a one-time deployment.
41
- After deployment completion, the response includes a `deploymentUrl` and an `id`, which is the deployment ID. For more information, see [here](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-generative-ai-model-in-sap-ai-core).
42
+ After deployment completion, the response includes a `deploymentUrl` and an `id`, which is the deployment ID.
43
+ For more information, see [here](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-deployment-for-generative-ai-model-in-sap-ai-core).
42
44
  [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.
43
45
 
44
46
  Consequently, each deployment ID and resource group uniquely map to a combination of model and model version within the `foundation-models` scenario.
@@ -178,9 +180,10 @@ For local testing instructions, refer to this [section](https://github.com/SAP/a
178
180
 
179
181
  ## Support, Feedback, Contribution
180
182
 
181
- This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/ai-sdk-js/issues).
183
+ This project is open to feature requests, bug reports and questions via [GitHub issues](https://github.com/SAP/ai-sdk-js/issues).
182
184
 
183
- Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](https://github.com/SAP/ai-sdk-js/blob/main/CONTRIBUTING.md).
185
+ Contribution and feedback are encouraged and always welcome.
186
+ For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](https://github.com/SAP/ai-sdk-js/blob/main/CONTRIBUTING.md).
184
187
 
185
188
  ## License
186
189
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap-ai-sdk/foundation-models",
3
- "version": "1.1.1-20241011013059.0",
3
+ "version": "1.1.1-20241012013050.0",
4
4
  "description": "",
5
5
  "license": "Apache-2.0",
6
6
  "keywords": [
@@ -22,8 +22,8 @@
22
22
  "dependencies": {
23
23
  "@sap-cloud-sdk/http-client": "^3.22.1",
24
24
  "@sap-cloud-sdk/util": "^3.22.1",
25
- "@sap-ai-sdk/ai-api": "^1.1.1-20241011013059.0",
26
- "@sap-ai-sdk/core": "^1.1.1-20241011013059.0"
25
+ "@sap-ai-sdk/ai-api": "^1.1.1-20241012013050.0",
26
+ "@sap-ai-sdk/core": "^1.1.1-20241012013050.0"
27
27
  },
28
28
  "scripts": {
29
29
  "compile": "tsc",