@adobe/spacecat-shared-gpt-client 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-gpt-client-v1.3.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.3.1...@adobe/spacecat-shared-gpt-client-v1.3.2) (2024-11-23)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#454](https://github.com/adobe/spacecat-shared/issues/454)) ([325cf8d](https://github.com/adobe/spacecat-shared/commit/325cf8dded5fcabadaf7d8fdd510d33aeafd08a7))
+
+# [@adobe/spacecat-shared-gpt-client-v1.3.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.3.0...@adobe/spacecat-shared-gpt-client-v1.3.1) (2024-11-15)
+
+
+### Bug Fixes
+
+* SITES-26948 [Import Assistant] Allow calls to Firefall to use specified ims org id ([#443](https://github.com/adobe/spacecat-shared/issues/443)) ([a63016c](https://github.com/adobe/spacecat-shared/commit/a63016c426ae8a4c0f7f66653e49f1098d466ee8))
+
 # [@adobe/spacecat-shared-gpt-client-v1.3.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-gpt-client-v1.2.22...@adobe/spacecat-shared-gpt-client-v1.3.0) (2024-11-12)
 
 

package/README.md

@@ -10,6 +10,11 @@ To use the `FirefallClient`, you need to configure it with the following paramet
 - `FIREFALL_API_KEY`: Your API key for accessing the Firefall API.
 - `FIREFALL_API_CAPABILITY_NAME`: The capability name for the Firefall API.
 
+Optionally, you can specify the IMS ORG ID to use when calling the Firefall APIs.  If this value is not specified, the IMS_CLIENT_ID (see below) will
+be used for the header's value:
+
+- `FIREFALL_IMS_ORG_ID`: The IMS ORG ID to use when calling the Firefall APIs and tracking the request.
+
 These parameters can be set through environment variables or passed directly to the `FirefallClient.createFrom` method.
 
 Additionally, the configuration for the `@adobe/spacecat-shared-ims-client` library is required to fetch the service access token from the IMS API:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-gpt-client",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Shared modules of the Spacecat Services - GPT Client",
   "type": "module",
   "engines": {
@@ -45,6 +45,6 @@
     "nock": "13.5.6",
     "sinon": "19.0.2",
     "sinon-chai": "4.0.0",
-    "typescript": "5.6.3"
+    "typescript": "5.7.2"
   }
 }

package/src/clients/firefall-client.js

@@ -50,7 +50,8 @@ export default class FirefallClient {
 
     const {
       FIREFALL_API_ENDPOINT: apiEndpoint,
-      IMS_CLIENT_ID: imsOrg,
+      IMS_CLIENT_ID: imsClientId,
+      FIREFALL_IMS_ORG_ID: firefallImsOrgId,
       FIREFALL_API_KEY: apiKey,
       FIREFALL_API_POLL_INTERVAL: pollInterval = 2000,
       FIREFALL_API_CAPABILITY_NAME: capabilityName = 'gpt4_32k_completions_capability',
@@ -69,7 +70,7 @@ export default class FirefallClient {
       apiKey,
       capabilityName,
       imsClient,
-      imsOrg,
+      imsOrg: firefallImsOrgId || imsClientId,
       pollInterval,
     }, log);
   }
@@ -107,6 +108,12 @@ export default class FirefallClient {
     this.log.debug(`${message}: took ${duration}ms`);
   }
 
+  /**
+   * Submit a prompt to the Firefall API.
+   * @param body The body of the request.
+   * @param path The Firefall API path.
+   * @returns {Promise<unknown>}
+   */
   async #submitPrompt(body, path) {
     const apiAuth = await this.#getApiAuth();
 
@@ -184,7 +191,11 @@ export default class FirefallClient {
    * @returns {Object} - AI response
    */
   async fetchChatCompletion(prompt, options = {}) {
-    const { imageUrls, responseFormat, model: llmModel = 'gpt-4-turbo' } = options || {};
+    const {
+      imageUrls,
+      responseFormat,
+      model: llmModel = 'gpt-4-turbo',
+    } = options || {};
     const hasImageUrls = imageUrls && imageUrls.length > 0;
 
     const getBody = () => {
@@ -246,10 +257,7 @@ export default class FirefallClient {
       const startTime = process.hrtime.bigint();
       const body = getBody();
 
-      chatSubmissionResponse = await this.#submitPrompt(
-        JSON.stringify(body),
-        '/v2/chat/completions',
-      );
+      chatSubmissionResponse = await this.#submitPrompt(JSON.stringify(body), '/v2/chat/completions');
       this.#logDuration('Firefall API Chat Completion call', startTime);
     } catch (error) {
       this.log.error('Error while fetching data from Firefall chat API: ', error.message);