@sap-ai-sdk/foundation-models - npm Package Compare versions

Comparing version 1.0.1-20241004013114.0 to 1.1.0

dist/azure-openai/client/inference/schema/azure-chat-extension-configuration.d.ts

 import type { AzureOpenAiAzureSearchChatExtensionConfiguration } from './azure-search-chat-extension-configuration.js';
 import type { AzureOpenAiAzureCosmosDBChatExtensionConfiguration } from './azure-cosmos-db-chat-extension-configuration.js';
 /**
- *   A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat
- *   completions request that should use Azure OpenAI chat extensions to augment the response behavior.
- *   The use of this configuration is compatible only with Azure OpenAI.
+ * A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat
+ * completions request that should use Azure OpenAI chat extensions to augment the response behavior.
+ * The use of this configuration is compatible only with Azure OpenAI.
  */
@@ -8,0 +8,0 @@ export type AzureOpenAiAzureChatExtensionConfiguration = ({

dist/azure-openai/client/inference/schema/azure-chat-extension-type.d.ts

 /**
- *   A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat
- *   completions request that should use Azure OpenAI chat extensions to augment the response behavior.
- *   The use of this configuration is compatible only with Azure OpenAI.
+ * A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat
+ * completions request that should use Azure OpenAI chat extensions to augment the response behavior.
+ * The use of this configuration is compatible only with Azure OpenAI.
  */
 export type AzureOpenAiAzureChatExtensionType = 'azure_search' | 'azure_cosmos_db';
 //# sourceMappingURL=azure-chat-extension-type.d.ts.map

dist/azure-openai/client/inference/schema/azure-chat-extensions-message-context.d.ts

 import type { AzureOpenAiCitation } from './citation.js';
 /**
- *   A representation of the additional context information available when Azure OpenAI chat extensions are involved
- *   in the generation of a corresponding chat completions response. This context information is only populated when
- *   using an Azure OpenAI request configured to use a matching extension.
+ * A representation of the additional context information available when Azure OpenAI chat extensions are involved
+ * in the generation of a corresponding chat completions response. This context information is only populated when
+ * using an Azure OpenAI request configured to use a matching extension.
  */
@@ -7,0 +7,0 @@ export type AzureOpenAiAzureChatExtensionsMessageContext = {

dist/azure-openai/client/inference/schema/azure-cosmos-db-chat-extension-configuration.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiAzureChatExtensionType } from './azure-chat-extension-type.js';
 import type { AzureOpenAiAzureCosmosDBChatExtensionParameters } from './azure-cosmos-db-chat-extension-parameters.js';
@@ -8,3 +7,3 @@ /**
 export type AzureOpenAiAzureCosmosDBChatExtensionConfiguration = {
-    type: AzureOpenAiAzureChatExtensionType;
+    type: string;
 } & {
@@ -11,0 +10,0 @@ parameters: AzureOpenAiAzureCosmosDBChatExtensionParameters;

dist/azure-openai/client/inference/schema/azure-search-chat-extension-configuration.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiAzureChatExtensionType } from './azure-chat-extension-type.js';
 import type { AzureOpenAiAzureSearchChatExtensionParameters } from './azure-search-chat-extension-parameters.js';
@@ -8,3 +7,3 @@ /**
 export type AzureOpenAiAzureSearchChatExtensionConfiguration = {
-    type: AzureOpenAiAzureChatExtensionType;
+    type: string;
 } & {
@@ -11,0 +10,0 @@ parameters: AzureOpenAiAzureSearchChatExtensionParameters;

dist/azure-openai/client/inference/schema/chat-completion-request-message-assistant.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageRole } from './chat-completion-request-message-role.js';
 import type { AzureOpenAiChatCompletionMessageToolCall } from './chat-completion-message-tool-call.js';
@@ -8,3 +7,3 @@ import type { AzureOpenAiAzureChatExtensionsMessageContext } from './azure-chat-extensions-message-context.js';
 export type AzureOpenAiChatCompletionRequestMessageAssistant = {
-    role: AzureOpenAiChatCompletionRequestMessageRole;
+    role: string;
 } & {
@@ -11,0 +10,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-content-part-image.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageContentPartType } from './chat-completion-request-message-content-part-type.js';
 import type { AzureOpenAiImageDetailLevel } from './image-detail-level.js';
@@ -7,3 +6,3 @@ /**
 export type AzureOpenAiChatCompletionRequestMessageContentPartImage = {
-    type: AzureOpenAiChatCompletionRequestMessageContentPartType;
+    type: string;
 } & {
@@ -10,0 +9,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-content-part-text.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageContentPartType } from './chat-completion-request-message-content-part-type.js';
 /**
@@ -6,3 +5,3 @@ * Representation of the 'AzureOpenAiChatCompletionRequestMessageContentPartText' schema.
 export type AzureOpenAiChatCompletionRequestMessageContentPartText = {
-    type: AzureOpenAiChatCompletionRequestMessageContentPartType;
+    type: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-content-part-text.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=chat-completion-request-message-content-part-text.js.map

dist/azure-openai/client/inference/schema/chat-completion-request-message-function.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageRole } from './chat-completion-request-message-role.js';
 /**
@@ -6,3 +5,3 @@ * Representation of the 'AzureOpenAiChatCompletionRequestMessageFunction' schema.
 export type AzureOpenAiChatCompletionRequestMessageFunction = {
-    role: AzureOpenAiChatCompletionRequestMessageRole;
+    role: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-function.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=chat-completion-request-message-function.js.map

dist/azure-openai/client/inference/schema/chat-completion-request-message-system.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageRole } from './chat-completion-request-message-role.js';
 /**
@@ -6,3 +5,3 @@ * Representation of the 'AzureOpenAiChatCompletionRequestMessageSystem' schema.
 export type AzureOpenAiChatCompletionRequestMessageSystem = {
-    role: AzureOpenAiChatCompletionRequestMessageRole;
+    role: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-system.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=chat-completion-request-message-system.js.map

dist/azure-openai/client/inference/schema/chat-completion-request-message-tool.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageRole } from './chat-completion-request-message-role.js';
 /**
@@ -6,3 +5,3 @@ * Representation of the 'AzureOpenAiChatCompletionRequestMessageTool' schema.
 export type AzureOpenAiChatCompletionRequestMessageTool = {
-    role: AzureOpenAiChatCompletionRequestMessageRole;
+    role: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/chat-completion-request-message-tool.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=chat-completion-request-message-tool.js.map

dist/azure-openai/client/inference/schema/chat-completion-request-message-user.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiChatCompletionRequestMessageRole } from './chat-completion-request-message-role.js';
 import type { AzureOpenAiChatCompletionRequestMessageContentPart } from './chat-completion-request-message-content-part.js';
@@ -7,3 +6,3 @@ /**
 export type AzureOpenAiChatCompletionRequestMessageUser = {
-    role: AzureOpenAiChatCompletionRequestMessageRole;
+    role: string;
 } & {
@@ -10,0 +9,0 @@ content: string | AzureOpenAiChatCompletionRequestMessageContentPart[] | null;

dist/azure-openai/client/inference/schema/create-chat-completion-request.d.ts

@@ -18,4 +18,4 @@ import type { AzureOpenAiChatCompletionsRequestCommon } from './chat-completions-request-common.js';
     /**
-     *   The configuration entries for Azure OpenAI chat extensions that use them.
-     *   This additional specification is only compatible with Azure OpenAI.
+     * The configuration entries for Azure OpenAI chat extensions that use them.
+     * This additional specification is only compatible with Azure OpenAI.
      */
@@ -22,0 +22,0 @@ data_sources?: AzureOpenAiAzureChatExtensionConfiguration[];

dist/azure-openai/client/inference/schema/on-your-data-api-key-authentication-options.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataAuthenticationType } from './on-your-data-authentication-type.js';
 /**
@@ -6,3 +5,3 @@ * The authentication options for Azure OpenAI On Your Data when using an API key.
 export type AzureOpenAiOnYourDataApiKeyAuthenticationOptions = {
-    type: AzureOpenAiOnYourDataAuthenticationType;
+    type: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/on-your-data-api-key-authentication-options.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=on-your-data-api-key-authentication-options.js.map

dist/azure-openai/client/inference/schema/on-your-data-connection-string-authentication-options.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataAuthenticationType } from './on-your-data-authentication-type.js';
 /**
@@ -6,3 +5,3 @@ * The authentication options for Azure OpenAI On Your Data when using a connection string.
 export type AzureOpenAiOnYourDataConnectionStringAuthenticationOptions = {
-    type: AzureOpenAiOnYourDataAuthenticationType;
+    type: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/on-your-data-connection-string-authentication-options.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=on-your-data-connection-string-authentication-options.js.map

dist/azure-openai/client/inference/schema/on-your-data-deployment-name-vectorization-source.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataVectorizationSourceType } from './on-your-data-vectorization-source-type.js';
 /**
@@ -7,3 +6,3 @@ * The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based
 export type AzureOpenAiOnYourDataDeploymentNameVectorizationSource = {
-    type: AzureOpenAiOnYourDataVectorizationSourceType;
+    type: string;
 } & {
@@ -10,0 +9,0 @@ /**

dist/azure-openai/client/inference/schema/on-your-data-deployment-name-vectorization-source.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=on-your-data-deployment-name-vectorization-source.js.map

dist/azure-openai/client/inference/schema/on-your-data-endpoint-vectorization-source.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataVectorizationSourceType } from './on-your-data-vectorization-source-type.js';
 import type { AzureOpenAiOnYourDataApiKeyAuthenticationOptions } from './on-your-data-api-key-authentication-options.js';
@@ -8,3 +7,3 @@ /**
 export type AzureOpenAiOnYourDataEndpointVectorizationSource = {
-    type: AzureOpenAiOnYourDataVectorizationSourceType;
+    type: string;
 } & {
@@ -11,0 +10,0 @@ authentication: AzureOpenAiOnYourDataApiKeyAuthenticationOptions;

dist/azure-openai/client/inference/schema/on-your-data-system-assigned-managed-identity-authentication-options.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataAuthenticationType } from './on-your-data-authentication-type.js';
 /**
@@ -6,4 +5,4 @@ * The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
 export type AzureOpenAiOnYourDataSystemAssignedManagedIdentityAuthenticationOptions = {
-    type: AzureOpenAiOnYourDataAuthenticationType;
+    type: string;
 };
 //# sourceMappingURL=on-your-data-system-assigned-managed-identity-authentication-options.d.ts.map

dist/azure-openai/client/inference/schema/on-your-data-system-assigned-managed-identity-authentication-options.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=on-your-data-system-assigned-managed-identity-authentication-options.js.map

dist/azure-openai/client/inference/schema/on-your-data-user-assigned-managed-identity-authentication-options.d.ts

@@ -1,2 +0,1 @@
-import type { AzureOpenAiOnYourDataAuthenticationType } from './on-your-data-authentication-type.js';
 /**
@@ -6,3 +5,3 @@ * The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
 export type AzureOpenAiOnYourDataUserAssignedManagedIdentityAuthenticationOptions = {
-    type: AzureOpenAiOnYourDataAuthenticationType;
+    type: string;
 } & {
@@ -9,0 +8,0 @@ /**

dist/azure-openai/client/inference/schema/on-your-data-user-assigned-managed-identity-authentication-options.js

@@ -0,2 +1,7 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
 export {};
 //# sourceMappingURL=on-your-data-user-assigned-managed-identity-authentication-options.js.map

package.json

 {
   "name": "@sap-ai-sdk/foundation-models",
-  "version": "1.0.1-20241004013114.0",
+  "version": "1.1.0",
   "description": "",
@@ -25,4 +25,4 @@ "license": "Apache-2.0",
     "@sap-cloud-sdk/util": "^3.21.0",
-    "@sap-ai-sdk/core": "^1.0.1-20241004013114.0",
-    "@sap-ai-sdk/ai-api": "^1.0.1-20241004013114.0"
+    "@sap-ai-sdk/ai-api": "^1.1.0",
+    "@sap-ai-sdk/core": "^1.1.0"
   },
@@ -29,0 +29,0 @@ "scripts": {

README.md

@@ -7,5 +7,5 @@ # @sap-ai-sdk/foundation-models
 
-- [Table of Contents](#table-of-contents)
 - [Installation](#installation)
 - [Prerequisites](#prerequisites)
+- [Relationship between Models and Deployment ID](#relationship-between-models-and-deployment-id)
 - [Usage](#usage)
@@ -16,2 +16,3 @@ - [Client Initialization](#client-initialization)
   - [Custom Request Configuration](#custom-request-configuration)
+- [Local Testing](#local-testing)
 - [Support, Feedback, Contribution](#support-feedback-contribution)
@@ -31,6 +32,18 @@ - [License](#license)
 - A deployed OpenAI model in SAP Generative AI hub.
-  - Use the [`DeploymentApi`](../ai-api/README.md#deploymentapi) from `@sap-ai-sdk/ai-api` to deploy a model to SAP generative AI hub. 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).
+  - 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.
+    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).
     Deployment can be set up for each model and model version, as well as a resource group intended for use with the generative AI hub.
-  - Once a deployment is complete, the model can be accessed via the `deploymentUrl`
+  - Once a deployment is complete, the model can be accessed via the `deploymentUrl`.
 
+## Relationship between Models and Deployment ID
+
+SAP AI Core manages access to generative AI models through the global AI scenario `foundation-models`.
+Creating a deployment for a model requires access to this scenario.
+
+Each model, model version, and resource group allows for a one-time deployment.
+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).
+[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.
+
+Consequently, each deployment ID and resource group uniquely map to a combination of model and model version within the `foundation-models` scenario.
+
 ## Usage
@@ -56,4 +69,2 @@
 
-[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.
-
 The deployment ID and resource group can be used as an alternative to the model name for obtaining a model.
@@ -168,2 +179,6 @@
 
+## Local Testing
+
+For local testing instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#local-testing).
+
 ## Support, Feedback, Contribution
@@ -170,0 +185,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Lines of code

2058

increased by1.48%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

188

increased by8.67%

Worsened metrics

Total package byte prevSize

184797

decreased by-0.25%

Dependency changes

• Updated@sap-ai-sdk/ai-api@^1.1.0

• Updated@sap-ai-sdk/core@^1.1.0