@salesforce/lds-adapters-sfap-einstein-ai-gateway 1.266.0-dev1 → 1.266.0-dev11

package/README.md

@@ -0,0 +1,18 @@
+# SFAP Einstein AI Gateway
+
+## api.raml
+
+Einstein AI gateway Wires are based on Salesforce API Platfrom(SFAP) and not Connect API.
+Steps to get RAML for api.raml file
+
+1. Go to Mulesoft Anypoint Exchange
+2. Search for "EinsteinGPT Foundations LLM Gateway APIs" and click on the item.
+3. Click on Download button on the page and download "As RAML"
+4. Mulesoft Generated RAML is not compatible with luvio. Handrolled lots of changes. Please cherry pick the changes, don't copy/paste.
+
+### Update on Dec 14, 2023
+
+- As part of addressing the SFAP header issue(W-14663142), we are overriding the createResourceRequest to support the default value for `xSfdcAppContext` header.
+- Once this is addressed with correct fix, please rollback.
+- Steps followed to override is listed here.  
+  https://bookish-sniffle-l8vm2yq.pages.github.io/#/how-to/override-generated-code

package/dist/es/es2018/sfap-einstein-ai-gateway.js

@@ -770,10 +770,18 @@ function ingestSuccess$1(luvio, resourceParams, response) {
     deepFreeze(snapshot.data);
     return snapshot;
 }
+
 function createResourceRequest$1(config) {
     const headers = {};
     headers['x-client-feature-id'] = config.headers.xClientFeatureId;
-    headers['x-LLM-Provider'] = config.headers.xLLMProvider;
+    const header_xSfdcAppContext = config.headers.xSfdcAppContext || 'EinsteinGPT'; /* Hand rolled default value*/
+    if (header_xSfdcAppContext !== undefined) {
+        headers['x-sfdc-app-context'] = header_xSfdcAppContext;
+    }
+    const header_xLLMProvider = config.headers.xLLMProvider;
+    if (header_xLLMProvider !== undefined) {
+        headers['x-LLM-Provider'] = header_xLLMProvider;
+    }
     return {
         baseUri: 'api.salesforce.com',
         basePath: '/ai/gpt/v1/generations',
@@ -800,7 +808,8 @@ const getGenerations_ConfigPropertyMetadata = [
     generateParamConfigMetadata('parameters', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('tags', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('xClientFeatureId', true, 3 /* Header */, 0 /* String */),
-    generateParamConfigMetadata('xLLMProvider', true, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xSfdcAppContext', false, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xLLMProvider', false, 3 /* Header */, 0 /* String */),
 ];
 const getGenerations_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$1, getGenerations_ConfigPropertyMetadata);
 const createResourceParams$1 = /*#__PURE__*/ createResourceParams$2(getGenerations_ConfigPropertyMetadata);
@@ -975,9 +984,12 @@ function ingestSuccess(luvio, resourceParams, response) {
     deepFreeze(snapshot.data);
     return snapshot;
 }
+
 function createResourceRequest(config) {
     const headers = {};
     headers['x-client-feature-id'] = config.headers.xClientFeatureId;
+    headers['x-sfdc-app-context'] =
+        config.headers.xSfdcAppContext || 'EinsteinGPT'; /* Hand rolled default value*/
     return {
         baseUri: 'api.salesforce.com',
         basePath: '/ai/gpt/v1/feedback',
@@ -993,12 +1005,16 @@ function createResourceRequest(config) {
 const adapterName = 'registerFeedback';
 const registerFeedback_ConfigPropertyMetadata = [
     generateParamConfigMetadata('id', true, 2 /* Body */, 0 /* String */),
-    generateParamConfigMetadata('generation_id', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('generation_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('turn_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('app_generation_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('app_generation', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('feedback', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('feedback_text', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('source', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('app_feedback', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('xClientFeatureId', true, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xSfdcAppContext', false, 3 /* Header */, 0 /* String */),
 ];
 const registerFeedback_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, registerFeedback_ConfigPropertyMetadata);
 const createResourceParams = /*#__PURE__*/ createResourceParams$2(registerFeedback_ConfigPropertyMetadata);

package/dist/es/es2018/types/src/generated/adapters/getGenerations.d.ts

@@ -7,7 +7,8 @@ export declare const getGenerations_ConfigPropertyMetadata: $64$luvio_engine_Ada
 export declare const getGenerations_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
 export interface GetGenerationsConfig {
     xClientFeatureId: string;
-    xLLMProvider: string;
+    xSfdcAppContext?: string;
+    xLLMProvider?: string;
     prompt: string;
     num_generations?: number;
     max_tokens?: number;

package/dist/es/es2018/types/src/generated/adapters/registerFeedback.d.ts

@@ -7,8 +7,12 @@ export declare const registerFeedback_ConfigPropertyMetadata: $64$luvio_engine_A
 export declare const registerFeedback_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
 export interface RegisterFeedbackConfig {
     xClientFeatureId: string;
+    xSfdcAppContext?: string;
     id: string;
-    generation_id: string;
+    generation_id?: string;
+    turn_id?: string;
+    app_generation_id?: string;
+    app_generation?: string;
     feedback?: string | null;
     feedback_text?: string;
     source?: string;

package/dist/es/es2018/types/src/generated/resources/postAiGptV1Feedback.d.ts

@@ -3,7 +3,10 @@ import { FeedbackResponseRepresentation as types_FeedbackResponseRepresentation_
 export interface ResourceRequestConfig {
     body: {
         id: string;
-        generation_id: string;
+        generation_id?: string;
+        turn_id?: string;
+        app_generation_id?: string;
+        app_generation?: string;
         feedback?: string | null;
         feedback_text?: string;
         source?: string;
@@ -13,6 +16,7 @@ export interface ResourceRequestConfig {
     };
     headers: {
         xClientFeatureId: string;
+        xSfdcAppContext?: string;
     };
 }
 export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;

package/dist/es/es2018/types/src/generated/resources/postAiGptV1Generations.d.ts

@@ -20,7 +20,8 @@ export interface ResourceRequestConfig {
     };
     headers: {
         xClientFeatureId: string;
-        xLLMProvider: string;
+        xSfdcAppContext?: string;
+        xLLMProvider?: string;
     };
 }
 export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;

package/dist/es/es2018/types/src/generated/types/FeedbackRequest.d.ts

@@ -1,5 +1,5 @@
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "677aa3c947477cdf2196296053ea3a8d";
+export declare const VERSION = "1ab8d6091197e3772731210a2d3678a9";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: FeedbackRequest, existing: FeedbackRequestNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FeedbackRequestNormalized;
@@ -18,16 +18,22 @@ export interface FeedbackRequestNormalized {
     app_feedback?: {
         [key: string]: unknown;
     };
+    /** The app-specific generation text to support cases where the client further splits a generation into multiple generations. */
+    app_generation?: string;
+    /** The app-specific generation ID to support cases where client further split a generation into multiple generations. */
+    app_generation_id?: string;
     /** The feedback sentiment. Can be `null`. */
     feedback?: string | null;
     /** The textual representation of the feedback as provided by the user. */
     feedback_text?: string;
     /** The ID of the gateway's generation response. For example, `GenerationResponseGenerations.id`. */
-    generation_id: string;
+    generation_id?: string;
     /** A unique ID for the feedback object. */
     id: string;
     /** The source of the feedback. For example, `human` or `app`. */
     source?: string;
+    /** The unique ID of a batch of generations to support to capture a single feedback for multiple generations. */
+    turn_id?: string;
 }
 /**
  *
@@ -39,9 +45,12 @@ export interface FeedbackRequest {
     app_feedback?: {
         [key: string]: unknown;
     };
+    app_generation?: string;
+    app_generation_id?: string;
     feedback?: string | null;
     feedback_text?: string;
-    generation_id: string;
+    generation_id?: string;
     id: string;
     source?: string;
+    turn_id?: string;
 }

package/dist/es/es2018/types/src/raml-artifacts/resources/postAiGptV1Feedback/createResourceRequest.d.ts

@@ -0,0 +1,21 @@
+import type { ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
+export interface ResourceRequestConfig {
+    body: {
+        id: string;
+        generation_id?: string;
+        turn_id?: string;
+        app_generation_id?: string;
+        app_generation?: string;
+        feedback?: string | null;
+        feedback_text?: string;
+        source?: string;
+        app_feedback?: {
+            [key: string]: unknown;
+        };
+    };
+    headers: {
+        xClientFeatureId: string;
+        xSfdcAppContext?: string;
+    };
+}
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;

package/dist/es/es2018/types/src/raml-artifacts/resources/postAiGptV1Generations/createResourceRequest.d.ts

@@ -0,0 +1,26 @@
+import type { ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
+export interface ResourceRequestConfig {
+    body: {
+        prompt: string;
+        num_generations?: number;
+        max_tokens?: number;
+        enable_pii_masking?: boolean;
+        temperature?: number;
+        stop_sequences?: Array<string>;
+        frequency_penalty?: number;
+        presence_penalty?: number;
+        model?: string;
+        parameters?: {
+            [key: string]: unknown;
+        };
+        tags?: {
+            [key: string]: unknown;
+        };
+    };
+    headers: {
+        xClientFeatureId: string;
+        xSfdcAppContext?: string;
+        xLLMProvider?: string;
+    };
+}
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-sfap-einstein-ai-gateway",
-    "version": "1.266.0-dev1",
+    "version": "1.266.0-dev11",
     "description": "LLM Gateway API's",
     "license": "SEE LICENSE IN LICENSE.txt",
     "main": "dist/es/es2018/sfap-einstein-ai-gateway.js",
@@ -32,7 +32,7 @@
     ],
     "scripts": {
         "build": "yarn build:services",
-        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p '../lds-compiler-plugins'",
+        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p './scripts/lds-adapters-sfap-einstein-ai-gateway-plugin.js'",
         "build:services": "rollup --bundleConfigAsCjs --config rollup.config.js",
         "clean": "rm -rf dist sfdc src/generated",
         "release:core": "../../scripts/release/core.js --adapter=lds-adapters-sfap-einstein-ai-gateway",
@@ -40,10 +40,10 @@
         "test:unit": "jest"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.266.0-dev1"
+        "@salesforce/lds-bindings": "^1.266.0-dev11"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.266.0-dev1"
+        "@salesforce/lds-compiler-plugins": "^1.266.0-dev11"
     },
     "nx": {
         "targets": {
@@ -54,6 +54,16 @@
                 ]
             },
             "build:raml": {
+                "inputs": [
+                    {
+                        "externalDependencies": [
+                            "@luvio/compiler",
+                            "@luvio/cli"
+                        ]
+                    },
+                    "{projectRoot}/**/*.raml",
+                    "{projectRoot}/scripts/**"
+                ],
                 "outputs": [
                     "{projectRoot}/src/generated"
                 ]

package/sfdc/index.js

@@ -779,10 +779,18 @@ function ingestSuccess$1(luvio, resourceParams, response) {
     deepFreeze(snapshot.data);
     return snapshot;
 }
+
 function createResourceRequest$1(config) {
     const headers = {};
     headers['x-client-feature-id'] = config.headers.xClientFeatureId;
-    headers['x-LLM-Provider'] = config.headers.xLLMProvider;
+    const header_xSfdcAppContext = config.headers.xSfdcAppContext || 'EinsteinGPT'; /* Hand rolled default value*/
+    if (header_xSfdcAppContext !== undefined) {
+        headers['x-sfdc-app-context'] = header_xSfdcAppContext;
+    }
+    const header_xLLMProvider = config.headers.xLLMProvider;
+    if (header_xLLMProvider !== undefined) {
+        headers['x-LLM-Provider'] = header_xLLMProvider;
+    }
     return {
         baseUri: 'api.salesforce.com',
         basePath: '/ai/gpt/v1/generations',
@@ -809,7 +817,8 @@ const getGenerations_ConfigPropertyMetadata = [
     generateParamConfigMetadata('parameters', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('tags', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('xClientFeatureId', true, 3 /* Header */, 0 /* String */),
-    generateParamConfigMetadata('xLLMProvider', true, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xSfdcAppContext', false, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xLLMProvider', false, 3 /* Header */, 0 /* String */),
 ];
 const getGenerations_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$1, getGenerations_ConfigPropertyMetadata);
 const createResourceParams$1 = /*#__PURE__*/ createResourceParams$2(getGenerations_ConfigPropertyMetadata);
@@ -984,9 +993,12 @@ function ingestSuccess(luvio, resourceParams, response) {
     deepFreeze(snapshot.data);
     return snapshot;
 }
+
 function createResourceRequest(config) {
     const headers = {};
     headers['x-client-feature-id'] = config.headers.xClientFeatureId;
+    headers['x-sfdc-app-context'] =
+        config.headers.xSfdcAppContext || 'EinsteinGPT'; /* Hand rolled default value*/
     return {
         baseUri: 'api.salesforce.com',
         basePath: '/ai/gpt/v1/feedback',
@@ -1002,12 +1014,16 @@ function createResourceRequest(config) {
 const adapterName = 'registerFeedback';
 const registerFeedback_ConfigPropertyMetadata = [
     generateParamConfigMetadata('id', true, 2 /* Body */, 0 /* String */),
-    generateParamConfigMetadata('generation_id', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('generation_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('turn_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('app_generation_id', false, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('app_generation', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('feedback', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('feedback_text', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('source', false, 2 /* Body */, 0 /* String */),
     generateParamConfigMetadata('app_feedback', false, 2 /* Body */, 4 /* Unsupported */),
     generateParamConfigMetadata('xClientFeatureId', true, 3 /* Header */, 0 /* String */),
+    generateParamConfigMetadata('xSfdcAppContext', false, 3 /* Header */, 0 /* String */),
 ];
 const registerFeedback_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, registerFeedback_ConfigPropertyMetadata);
 const createResourceParams = /*#__PURE__*/ createResourceParams$2(registerFeedback_ConfigPropertyMetadata);
@@ -1101,4 +1117,4 @@ withDefaultLuvio((luvio) => {
 });
 
 export { getGenerations, registerFeedback };
-// version: 1.266.0-dev1-0affa7d84
+// version: 1.266.0-dev11-54133651d

package/src/raml/api.raml

@@ -468,9 +468,18 @@ types:
       id:
         description: A unique ID for the feedback object.
         type: string
-      generation_id:
+      generation_id?:
         description: The ID of the gateway's generation response. For example, `GenerationResponseGenerations.id`.
         type: string
+      turn_id?:
+        description: The unique ID of a batch of generations to support to capture a single feedback for multiple generations.
+        type: string
+      app_generation_id?:
+        description: The app-specific generation ID to support cases where client further split a generation into multiple generations.
+        type: string
+      app_generation?:
+        description: The app-specific generation text to support cases where the client further splits a generation into multiple generations.
+        type: string
       feedback?:
         description: The feedback sentiment. Can be `null`.
         enum:
@@ -616,9 +625,14 @@ version: v1
       'x-client-feature-id':
         type: string
         description: Client Feature Id.
+      'x-sfdc-app-context':
+        type: string
+        default: EinsteinGPT
+        required: false
+        description: SFDC app context.
       'x-LLM-Provider':
         description: Provider to use.
-        required: true
+        required: false
         enum:
           - OpenAI
           - Cohere
@@ -689,6 +703,11 @@ version: v1
       'x-client-feature-id':
         type: string
         description: Client Feature Id.
+      'x-sfdc-app-context':
+        type: string
+        default: EinsteinGPT
+        required: false
+        description: SFDC app context.
     body:
       application/json: FeedbackRequest
     responses: