@inductiv/node-red-openai-api 0.1.0 → 0.2.0

package/README.md

@@ -41,9 +41,9 @@ npm i @inductiv/node-red-openai-api
 
 ## Usage
 
-Find your _@inductiv/node-red-openai-api_ node in the **AI** palette category.
+Find your _@inductiv/node-red-openai-api_ node in the **AI** palette category, labeled "OpenAI API.
 
-<img width="122" alt="inductiv-node-red-openai-api-node" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/55b6528a-0f94-4e24-8c98-f47104624651">
+<img width="122" alt="inductiv-node-red-openai-api-node" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/1ca1ef14-1839-4355-9f1e-ba4f94cfd2a6">
 
 You'll find a set of example implementation flows in the [examples](./examples/) directory.
 

package/examples/assistants.json

@@ -356,7 +356,7 @@
     },
     {
         "id": "50dc0daeab93f1d7",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "78b174792ca9efaf",
         "g": "6ada9879e91ef156",
         "name": "upload files",
@@ -404,7 +404,7 @@
     },
     {
         "id": "43d56c48fd18dd0b",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "78b174792ca9efaf",
         "g": "a08cc5475a20cc70",
         "name": "create assistant",

package/examples/audio.json

@@ -39,7 +39,7 @@
     },
     {
         "id": "72303cea19bd9de9",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "a8f46f8122644718",
         "name": "translator",
         "service": "808a04cb8707d787",

package/examples/chat.json

@@ -71,7 +71,7 @@
     },
     {
         "id": "765e638b2f084d76",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "acd4d3697fd487ee",
         "name": "chat completion",
         "service": "71860aa02b1968e3",

package/examples/embeddings.json

@@ -56,7 +56,7 @@
     },
     {
         "id": "5096e563fd5b02cf",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "70307b6cbfb7a7c8",
         "name": "create embeddings",
         "service": "39eba92e93450944",

package/examples/files.json

@@ -56,7 +56,7 @@
     },
     {
         "id": "b2eb824897e04b08",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "1e45d9e751f7d036",
         "name": "list files",
         "service": "",

package/examples/fine-tuning.json

@@ -56,7 +56,7 @@
     },
     {
         "id": "bdaf36c829550e41",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "6920fb391b5cefcd",
         "name": "list fine-tuning jobs",
         "service": "",

package/examples/images.json

@@ -66,7 +66,7 @@
     },
     {
         "id": "979e1bb6732cc292",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "8b5b83e806871f8b",
         "name": "create image",
         "service": "",

package/examples/messages.json

@@ -61,7 +61,7 @@
     },
     {
         "id": "932b2514509c22ea",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "47d8fb0adff5a6cc",
         "name": "list messages",
         "service": "",

package/examples/models.json

@@ -29,7 +29,7 @@
     },
     {
         "id": "535006a3343dacc3",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "2610fa513fed33f5",
         "name": "list models",
         "service": "",

package/examples/moderations.json

@@ -51,7 +51,7 @@
     },
     {
         "id": "58bfb89e83e4cc78",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "4e4adf62cc07faa5",
         "name": "create moderation",
         "service": "",

package/examples/runs.json

@@ -51,7 +51,7 @@
     },
     {
         "id": "bf9fee6ecdfaf14d",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "1dc20442cfd01082",
         "name": "list runs",
         "service": "",

package/examples/threads.json

@@ -51,7 +51,7 @@
     },
     {
         "id": "e0bcde3186fc61aa",
-        "type": "openai-api",
+        "type": "OpenAI API",
         "z": "ec716b03b671e83a",
         "name": "retrieve thread",
         "service": "",

package/lib.js

@@ -1,8 +1,5 @@
 /*jshint -W069 */
 
-const { threadId } = require('worker_threads');
-const { v4: uuidv4 } = require('uuid');
-const FileType = require('file-type');
 
 var OpenaiApi = (function () {
     'use strict';
@@ -103,7 +100,6 @@ var OpenaiApi = (function () {
 
     OpenaiApi.prototype.getFromEndpoint = function (path, parameters, expectedQueryParams, customHeaders) {
         return new Promise((resolve, reject) => {
-            // parameters = parameters || {};
             var domain = this.domain;
             var queryParameters = {}, baseHeaders = {};
 
@@ -136,7 +132,7 @@ var OpenaiApi = (function () {
                 params: queryParameters
             };
 
-            // Axios POST request
+            // Axios GET request
             axios(config)
                 .then(response => {
                     resolve(response);
@@ -259,7 +255,7 @@ var OpenaiApi = (function () {
                 params: queryParameters
             };
 
-            // Axios POST request
+            // Axios DELETE request
             axios(config)
                 .then(response => {
                     resolve(response);
@@ -392,8 +388,8 @@ var OpenaiApi = (function () {
     };
 
     OpenaiApi.prototype.listAssistants = function (parameters) {
-        var expectedQueryParameters = ['limit', 'order', 'after', 'before'];
-        var customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
+        const expectedQueryParameters = ['limit', 'order', 'after', 'before'];
+        const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
 
         return this.getFromEndpoint('/assistants', parameters, expectedQueryParameters, customHeaders);
     };
@@ -474,7 +470,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.getMessage = function (parameters) {
 
         const threadId = parameters.body.thread_id;
-        const messageId = parameters.messageId;
+        const messageId = parameters.body.message_id;
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
 
         return this.getFromEndpoint(`/threads/${threadId}/messages/${messageId}`, parameters, null, customHeaders);
@@ -483,7 +479,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.modifyMessage = function (parameters) {
 
         const threadId = parameters.body.thread_id;
-        const messageId = parameters.messageId;
+        const messageId = parameters.body.message_id;
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
 
         return this.postToEndpoint(`/threads/${threadId}/messages/${messageId}`, parameters, null, null, null, customHeaders);
@@ -514,7 +510,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.getRun = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
+        const runId = parameters.body.run_id;
 
         return this.getFromEndpoint(`/threads/${threadId}/runs/${runId}`, parameters, null, customHeaders);
     };
@@ -522,7 +518,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.modifyRun = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
+        const runId = parameters.body.run_id;
 
         return this.postToEndpoint(`/threads/${threadId}/runs/${runId}`, parameters, null, null, null, customHeaders);
     };
@@ -530,7 +526,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.submitToolOuputsToRun = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
+        const runId = parameters.body.run_id;
 
         return this.postToEndpoint(`/threads/${threadId}/runs/${runId}/submit_tool_outputs`, parameters, null, null, null, customHeaders);
     };
@@ -538,7 +534,7 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.cancelRun = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
+        const runId = parameters.body.run_id;
 
         return this.postToEndpoint(`/threads/${threadId}/runs/${runId}/cancel`, parameters, null, null, null, customHeaders);
     };
@@ -546,7 +542,8 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.listRunSteps = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
+        const runId = parameters.body.run_id;
+        const expectedQueryParameters = ['limit', 'order', 'after', 'before'];
 
         return this.getFromEndpoint(`/threads/${threadId}/runs/${runId}/steps`, parameters, null, customHeaders);
     };
@@ -554,23 +551,24 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.getRunStep = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const runId = parameters.runId;
-        const stepId = parameters.stepId;
+        const runId = parameters.body.run_id;
+        const stepId = parameters.body.step_id;
 
         return this.getFromEndpoint(`/threads/${threadId}/runs/${runId}/steps/${stepId}`, parameters, null, customHeaders);
     };
 
     OpenaiApi.prototype.listAssistantFiles = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
-        const assistantId = parameters.assistantId;
+        const assistantId = parameters.body.assistant_id;
+        const expectedQueryParameters = ['limit', 'order', 'after', 'before'];
 
-        return this.getFromEndpoint(`/assistants/${assistantId}/files`, parameters, null, customHeaders);
+        return this.getFromEndpoint(`/assistants/${assistantId}/files`, parameters, expectedQueryParameters, customHeaders);
     };
 
     OpenaiApi.prototype.createAssistantFile = function (parameters) {
 
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
-        const assistantId = parameters.assistantId;
+        const assistantId = parameters.body.assistant_id;
 
         return this.postToEndpoint(`/assistants/${assistantId}/files`, parameters, null, null, null, customHeaders);
     };
@@ -578,8 +576,8 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.getAssistantFile = function (parameters) {
 
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
-        const assistantId = parameters.assistantId;
-        const fileId = parameters.fileId;
+        const assistantId = parameters.body.assistant_id;
+        const fileId = parameters.body.file_id;
 
         return this.getFromEndpoint(`/assistants/${assistantId}/files/${fileId}`, parameters, null, customHeaders);
     };
@@ -587,8 +585,8 @@ var OpenaiApi = (function () {
     OpenaiApi.prototype.deleteAssistantFile = function (parameters) {
 
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
-        const assistantId = parameters.assistantId;
-        const fileId = parameters.fileId;
+        const assistantId = parameters.body.assistant_id;
+        const fileId = parameters.body.file_id;
 
         return this.deleteFromEndpoint(`/assistants/${assistantId}/files/${fileId}`, parameters, null, customHeaders);
     };
@@ -597,16 +595,17 @@ var OpenaiApi = (function () {
 
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const messageId = parameters.messageId;
+        const messageId = parameters.body.message_id;
+        const expectedQueryParameters = ['limit', 'order', 'after', 'before'];
 
-        return this.getFromEndpoint(`/threads/${threadId}/messages/${messageId}/files`, parameters, null, customHeaders);
+        return this.getFromEndpoint(`/threads/${threadId}/messages/${messageId}/files`, parameters, expectedQueryParameters, customHeaders);
     };
 
     OpenaiApi.prototype.getMessageFile = function (parameters) {
         const customHeaders = { 'OpenAI-Beta': 'assistants=v1' };
         const threadId = parameters.body.thread_id;
-        const messageId = parameters.messageId;
-        const fileId = parameters.fileId;
+        const messageId = parameters.body.message_id;
+        const fileId = parameters.body.file_id;
 
         return this.getFromEndpoint(`/threads/${threadId}/messages/${messageId}/files/${fileId}`, parameters, null, customHeaders);
     };

package/node.html

@@ -1,17 +1,17 @@
 <script type="text/javascript">
-    RED.nodes.registerType('openai-api', {
+    RED.nodes.registerType('OpenAI API', {
         category: 'AI',
         color: '#B8B1FB',
         defaults: {
             name: { value: "" },
-            service: { value: "", type: "openai-api-service", required: true },
+            service: { value: "", type: "OpenAI Auth", required: true },
             method: { value: "", required: true }
         },
         inputs: 1,
         outputs: 1,
         icon: 'icon.png',
         label: function () {
-            return this.name || this.method || "openai-api";
+            return this.name || this.method || "OpenAI API";
         },
         labelStyle: function () {
             return this.name ? "node_label_italic" : "";
@@ -27,7 +27,7 @@
     });
 </script>
 
-<script type="text/html" data-template-name="openai-api">
+<script type="text/html" data-template-name="OpenAI API">
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
         <input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
@@ -120,7 +120,7 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="openai-api">
+<script type="text/html" data-help-name="OpenAI API">
     <p>OpenAI Platform Services API. Please see the <a href="https://platform.openai.com/docs/api-reference" target="_blank">OpenAI API Reference</a> for more details.</p>
     <p><b>Reference</b></p>
 
@@ -710,7 +710,7 @@
 </script>
 
 <script type="text/javascript">
-    RED.nodes.registerType('openai-api-service', {
+    RED.nodes.registerType('OpenAI Auth', {
         category: 'config',
         defaults: {
 
@@ -740,7 +740,7 @@
     });
 </script>
 
-<script type="text/html" data-template-name="openai-api-service">
+<script type="text/html" data-template-name="OpenAI Auth">
 
     <div class="form-row">
         <label id="node-config-input-secureApiKeyHeaderOrQueryName-label" for="node-config-input-secureApiKeyHeaderOrQueryName"><i class="fa fa-list"></i> <span data-i18n="OpenaiApi.label.header"></span></label>
@@ -764,7 +764,7 @@
     </div>
 </script>
 
-<script type="text/html" data-help-name="openai-api-service">
+<script type="text/html" data-help-name="OpenAI Auth">
 
     <p><b>Header</b>: Variable name to set API key</p>
     <p><b>Value</b>: Value of API key</p>

package/node.js

@@ -238,8 +238,8 @@ module.exports = function (RED) {
         });
     }
 
-    RED.nodes.registerType('openai-api', OpenaiApiNode);
-    function OpenaiApiServiceNode(n) {
+    RED.nodes.registerType('OpenAI API', OpenaiApiNode);
+    function OAIAuthNode(n) {
         RED.nodes.createNode(this, n);
 
         this.secureApiKeyValue = n.secureApiKeyValue;
@@ -247,7 +247,7 @@ module.exports = function (RED) {
         this.secureApiKeyIsQuery = n.secureApiKeyIsQuery;
     }
 
-    RED.nodes.registerType('openai-api-service', OpenaiApiServiceNode, {
+    RED.nodes.registerType('OpenAI Auth', OAIAuthNode, {
         credentials: {
             secureApiKeyValue: { type: 'password' },
             temp: { type: 'text' }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Node-RED node for interfacing with OpenAI platform services",
   "main": "node.js",
   "engines": {
@@ -27,14 +27,7 @@
   ],
   "dependencies": {
     "axios": "^1.6.0",
-    "file-type": "^16.5.4",
-    "form-data": "^4.0.0",
-    "uuid": "^9.0.1"
-  },
-  "devDependencies": {
-    "mocha": "9.2.1",
-    "node-red": "2.2.2",
-    "node-red-node-test-helper": "0.2.7"
+    "form-data": "^4.0.0"
   },
   "author": "Allan Bunch",
   "license": "MIT",
@@ -42,4 +35,4 @@
     "type": "git",
     "url": "git+https://github.com/allanbunch/node-red-openai-api.git"
   }
-}
+}