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

package/README.md

@@ -2,7 +2,7 @@
   Node-RED OpenAI API: Unleashing AIoT Innovation
   <br>
 <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>
 @inductiv/node-red-openai-api
@@ -16,13 +16,13 @@ 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.2.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.
+- Added the [```fineTuning.jobs.checkpoints.list```](https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints) endpoint to the **Fine-tuning** API.
 - 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:
 

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) {
@@ -365,9 +363,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 +397,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 +457,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;
     }
@@ -689,7 +694,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "1.1.0",
+  "version": "1.2.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.40.2"
   },
   "devDependencies": {
     "eslint": "^8.54.0",
+    "eslint-plugin-jest": "^28.5.0",
     "prettier": "^3.1.0"
   },
   "author": "Allan Bunch",
@@ -46,4 +47,4 @@
     "type": "git",
     "url": "git+https://github.com/allanbunch/node-red-openai-api.git"
   }
-}
+}