@inductiv/node-red-openai-api 1.1.0 → 1.3.0

package/README.md

@@ -1,14 +1,39 @@
-<h1 align="center">
-  Node-RED OpenAI API: Unleashing AIoT Innovation
-  <br>
+
+# @inductiv/node-red-openai-api
+
+![NPM Version](https://img.shields.io/npm/v/%40inductiv%2Fnode-red-openai-api) ![GitHub Release Date](https://img.shields.io/github/release-date/allanbunch/node-red-openai-api) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/allanbunch/node-red-openai-api) ![GitHub Repo stars](https://img.shields.io/github/stars/allanbunch/node-red-openai-api)
+
+This library provides convenient access to the OpenAI Node API Library from Node-RED.
+
 <a href="https://github.com/allanbunch/node-red-openai-api">
-  <img width="265" alt="node-red-openai-api-node" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/9588aba4-0a97-4cbe-a446-58e06d5dd016">
+  <img width="265" alt="node-red-openai-api-node" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/ee954c8e-fbf4-4812-a38a-f047cecd1982">
 </a>
 <br>
+
+Node-RED OpenAI API is a versatile and configurable Node-RED node designed for seamless integration with any OpenAI API compatible platform. This node empowers innovators and developers to effortlessly connect and orchestrate complex AI and IoT workflows, leveraging Node-RED's sophisticated ecosystem. Ideal for enhancing IoT operations with advanced AI capabilities, this node serves as your gateway to applying the latest AI technology in an IoT context, facilitating innovative applications across diverse environments.
+
+## Installation
+
+### Via Node-RED Palette Manager
+
+```text
 @inductiv/node-red-openai-api
-</h1>
+```
 
-Welcome to _@inductiv/node-red-openai-api_, a versatile and configurable Node-RED node designed for seamless integration with any OpenAI API compatible platform. This node empowers innovators and developers to effortlessly connect and orchestrate complex AI and IoT workflows, leveraging Node-RED's sophisticated ecosystem. Ideal for enhancing IoT operations with advanced AI capabilities, this node serves as your gateway to applying the latest AI technology in an IoT context, facilitating innovative applications across diverse environments.
+### Via NPM
+
+```bash
+cd $HOME/.node-red # or the location of your Node-RED configuration directory.
+npm i @inductiv/node-red-openai-api
+```
+
+## Usage
+
+After installation, find your node in the **AI** palette category labeled "OpenAI API". Here's how you can start integrating AI into your IoT projects:
+
+1. Configure the node with your AI platform's API key (if required).
+2. Send [OpenAI documented](https://platform.openai.com/docs/api-reference/) API service configuration paramaters to the node using the default `msg.payload` property, or confiure your desired incoming object property reference on the node itself.
+3. Explore the [examples](./examples/) directory for sample implementations.
 
 ## Core Features
 
@@ -16,13 +41,14 @@ Welcome to _@inductiv/node-red-openai-api_, a versatile and configurable Node-RE
 - **Configurable and Flexible**: Adapt to a wide range of project requirements, making it easy to integrate AI into your IoT solutions.
 - **Powerful Combinations**: Utilize Node-RED's diverse nodes to build complex, AI-driven IoT workflows with ease.
 
-## Release Notes (v1.1.0)
+## Release Notes (v1.3.0)
 
-- **Fixed a bug** that prevented custom property paths not honored. [#22](https://github.com/allanbunch/node-red-openai-api/issues/22)
-- Added the ```vectorStores.fileBatches.uploadAndPoll``` endpoint to the **Vector Store File Batches** endpoint group.
-- Updated the node's documentation panel.
+- Streamed responses now share the same `msg._msgid` value
+- Upgraded to OpenAI Node API Library v4.42.0
+- Updated the node's documentation panel
+- Code stability & formatting updates
 
-## What's New in Version 1.0
+## What's New in Version 1.x
 
 Version 1.0 of the **node-red-openai-api** node brings significant enhancements and new possibilities, including:
 
@@ -34,36 +60,13 @@ Version 1.0 of the **node-red-openai-api** node brings significant enhancements
 
 ### Important Notice Regarding Compatibility
 
-- **Backward Incompatible Changes**: Please be aware that this version includes breaking changes that may affect existing implementations due to the updated OpenAI NodeJS package:
+- **Backward Incompatible Changes**: Please be aware that v1.0 includes breaking changes that may affect existing implementations (v0.x.x instllations) due to the updated OpenAI NodeJS package:
   - The API call structure and parameters have been refined to align with the latest OpenAI specifications.
   - Some functions and settings from previous versions may no longer be compatible with this update.
   - List responses now exist at the top level of the `msg.payload` object; previously `msg.payload.data`.
 
 I recommend reviewing current setups and testing them with this new version in a development environment before updating to ensure a smooth transition. This will help you take full advantage of the enhanced features while managing any necessary adjustments in your existing applications.
 
-## Installation
-
-### Via Node-RED Palette Manager
-
-```text
-@inductiv/node-red-openai-api
-```
-
-### Via NPM
-
-```bash
-cd $HOME/.node-red
-npm i @inductiv/node-red-openai-api
-```
-
-## Usage
-
-After installation, find your node in the **AI** palette category labeled "OpenAI API". Here's how you can start integrating AI into your IoT projects:
-
-1. Configure the node with your AI platform's API key (if required).
-2. Send [OpenAI documented](https://platform.openai.com/docs/api-reference/) API service configuration paramaters to the node using the default `msg.payload` property, or confiure your desired incoming object property reference on the node itself.
-3. Explore the [examples](./examples/) directory for sample implementations.
-
 ## Contribute
 
 I value community contributions that help enhance this Node-RED node and expand its capabilities in AIoT applications. Whether you're fixing bugs, adding new features, or improving documentation, your help is welcome!

package/lib.js

@@ -1,5 +1,3 @@
-const { response } = require("express");
-
 let OpenaiApi = (function () {
   "use strict";
 
@@ -121,31 +119,31 @@ let OpenaiApi = (function () {
 
     async uploadAndPollVectorStoreFileBatch(parameters) {
       const openai = new OpenAI(this.clientParams);
-      const { vector_store_id, files, file_ids, ...params } = parameters.payload;
-    
+      const { vector_store_id, files, file_ids, ...params } =
+        parameters.payload;
+
       if (!files || !Array.isArray(files)) {
         throw new Error("Files is not defined or not an array");
       }
-    
+
       // Validate file paths
-      files.forEach(path => {
+      files.forEach((path) => {
         if (!fs.existsSync(path)) {
           throw new Error(`File does not exist: ${path}`);
         }
       });
-    
-      const fileStreams = files.map(path => fs.createReadStream(path));
-    
+
+      const fileStreams = files.map((path) => fs.createReadStream(path));
+
       const response = await openai.beta.vectorStores.fileBatches.uploadAndPoll(
         vector_store_id,
-        {files: fileStreams, fileIds: file_ids},
-        params
+        { files: fileStreams, fileIds: file_ids },
+        params,
       );
-    
+
       return response;
     }
-    
-    
+
     // <<< End File Batch Functions
 
     async createVectorStore(parameters) {
@@ -242,9 +240,7 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let { _msgid, ...newMsg } = parameters.msg;
-            newMsg.payload = chunk;
-
+            const newMsg = { ...parameters.msg, payload: chunk };
             _node.send(newMsg);
           }
         }
@@ -365,9 +361,7 @@ let OpenaiApi = (function () {
 
     async createFineTuningJob(parameters) {
       const openai = new OpenAI(this.clientParams);
-      const response = await openai.fineTuning.jobs.create(
-        parameters.payload,
-      );
+      const response = await openai.fineTuning.jobs.create(parameters.payload);
 
       return response;
     }
@@ -401,6 +395,17 @@ let OpenaiApi = (function () {
       return [...list.data];
     }
 
+    async listFineTuningCheckpoints(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const { fine_tuning_job_id, ...params } = parameters.payload;
+      const list = await openai.fineTuning.jobs.checkpoints.list(
+        fine_tuning_job_id,
+        params,
+      );
+
+      return [...list.data];
+    }
+
     async cancelFineTuningJob(parameters) {
       const openai = new OpenAI(this.clientParams);
       const { fine_tuning_job_id, ...params } = parameters.payload;
@@ -450,9 +455,7 @@ let OpenaiApi = (function () {
 
     async createAssistant(parameters) {
       const openai = new OpenAI(this.clientParams);
-      const response = await openai.beta.assistants.create(
-        parameters.payload,
-      );
+      const response = await openai.beta.assistants.create(parameters.payload);
 
       return response;
     }
@@ -574,9 +577,7 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let { _msgid, ...newMsg } = parameters.msg;
-            newMsg.payload = chunk.data;
-
+            const newMsg = { ...parameters.msg, payload: chunk.data };
             _node.send(newMsg);
           }
         }
@@ -608,9 +609,7 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let { _msgid, ...newMsg } = parameters.msg;
-            newMsg.payload = chunk.data;
-
+            const newMsg = { ...parameters.msg, payload: chunk.data };
             _node.send(newMsg);
           }
         }
@@ -662,9 +661,7 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let { _msgid, ...newMsg } = parameters.msg;
-            newMsg.payload = chunk.data;
-
+            const newMsg = { ...parameters.msg, payload: chunk.data };
             _node.send(newMsg);
           }
         }
@@ -689,7 +686,11 @@ let OpenaiApi = (function () {
     async listRunSteps(parameters) {
       const openai = new OpenAI(this.clientParams);
       const { thread_id, run_id, ...params } = parameters.payload;
-      const list = await openai.beta.threads.runs.steps.list(thread_id, run_id, params);
+      const list = await openai.beta.threads.runs.steps.list(
+        thread_id,
+        run_id,
+        params,
+      );
 
       return [...list.data];
     }

package/locales/de-DE/node.json

@@ -81,6 +81,7 @@
             "retrieveFineTuningJob": "retrieve fine-tuning job",
             "fine_tuning_job_id": "fine-tuning job id",
             "listFineTuningEvents": "list fine-tuning events",
+            "listFineTuningCheckpoints": "list fine-tuning checkpoints",
             "cancelFineTuningJob": "cancel fine-tuning",
             "createFineTune": "POST /fine-tunes",
             "listFineTunes": "GET /fine-tunes",

package/locales/en-US/node.json

@@ -81,6 +81,7 @@
             "retrieveFineTuningJob": "retrieve fine-tuning job",
             "fine_tuning_job_id": "fine-tuning job id",
             "listFineTuningEvents": "list fine-tuning events",
+            "listFineTuningCheckpoints": "list fine-tuning checkpoints",
             "cancelFineTuningJob": "cancel fine-tuning",
             "createFineTune": "POST /fine-tunes",
             "listFineTunes": "GET /fine-tunes",

package/locales/ja/node.json

@@ -81,6 +81,7 @@
             "retrieveFineTuningJob": "retrieve fine-tuning job",
             "fine_tuning_job_id": "fine-tuning job id",
             "listFineTuningEvents": "list fine-tuning events",
+            "listFineTuningCheckpoints": "list fine-tuning checkpoints",
             "cancelFineTuningJob": "cancel fine-tuning",
             "createFineTune": "POST /fine-tunes",
             "listFineTunes": "GET /fine-tunes",

package/locales/zh-CN/node.json

@@ -81,6 +81,7 @@
             "retrieveFineTuningJob": "retrieve fine-tuning job",
             "fine_tuning_job_id": "fine-tuning job id",
             "listFineTuningEvents": "list fine-tuning events",
+            "listFineTuningCheckpoints": "list fine-tuning checkpoints",
             "cancelFineTuningJob": "cancel fine-tuning",
             "createFineTune": "POST /fine-tunes",
             "listFineTunes": "GET /fine-tunes",

package/node.html

@@ -182,6 +182,10 @@
           value="listFineTuningEvents"
           data-i18n="OpenaiApi.parameters.listFineTuningEvents"
         ></option>
+        <option
+          value="listFineTuningCheckpoints"
+          data-i18n="OpenaiApi.parameters.listFineTuningCheckpoints"
+        ></option>
         <option
           value="cancelFineTuningJob"
           data-i18n="OpenaiApi.parameters.cancelFineTuningJob"
@@ -1799,6 +1803,47 @@
           <dd>Number of events to retrieve.</dd>
         </dl>
 
+        <!-- >>> Begin List Fine-tuning Checkpoints -->
+        <h4 style="font-weight: bolder;"> ⋙ List Fine-tuning Checkpoints</h4>
+        <p>List checkpoints for a fine-tuning job.</p>
+        <dl class="message-properties">
+          <h4>msg.payload Properties</h4>
+
+          <dt>
+            fine_tuning_job_id
+            <a
+              href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-fine_tuning_job_id"
+              target="_blank"
+              ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+            ></a>
+            <span class="property-type">string</span>
+          </dt>
+          <dd>The ID of the fine-tuning job to get checkpoints for.</dd>
+          <dt class="optional">
+            after
+            <a
+              href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-after"
+              target="_blank"
+              ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+            ></a>
+            <span class="property-type">string</span>
+          </dt>
+          <dd>
+            Identifier for the last checkpoint ID from the previous pagination request.
+          </dd>
+          <dt class="optional">
+            limit
+            <a
+              href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-limit"
+              target="_blank"
+              ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+            ></a>
+            <span class="property-type">integer</span>
+          </dt>
+          <dd>Number of events to retrieve.</dd>
+        </dl>
+        <!-- <<< End List Fine-tuning Checkpoints -->
+
         <h4 style="font-weight: bolder;"> ⋙ Cancel Fine-tuning Job</h4>
         <p>Immediately cancel a fine-tune job.</p>
         <dl class="message-properties">

package/node.js

@@ -35,9 +35,9 @@ module.exports = function (RED) {
         const serviceName = node.config.method; // Set the service name to call.
 
         let serviceParametersObject = {
-          "_node": node,
-          "payload": payload,
-          "msg": msg
+          _node: node,
+          payload: payload,
+          msg: msg,
         };
 
         // Dynamically call the function based on the service name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Enhance your Node-RED flows with advanced AI capabilities.",
   "main": "node.js",
   "engines": {
@@ -34,10 +34,11 @@
     "low-code"
   ],
   "dependencies": {
-    "openai": "^4.38.5"
+    "openai": "~4.42.0"
   },
   "devDependencies": {
     "eslint": "^8.54.0",
+    "eslint-plugin-jest": "^28.5.0",
     "prettier": "^3.1.0"
   },
   "author": "Allan Bunch",