@inductiv/node-red-openai-api 0.4.1 → 0.6.0

package/README.md

@@ -9,19 +9,13 @@
 
 _@inductiv/node-red-openai-api_ offers a versatile and configurable Node-RED node, designed specifically for seamless integration with OpenAI's advanced platform services. It empowers you to effortlessly connect and orchestrate various OpenAI functionalities, leveraging the full power of Node-RED's sophisticated application nodes. Whether you're aiming to enhance your workflows with cutting-edge AI capabilities or create innovative applications, this node serves as your gateway to harnessing the latest in AI technology from OpenAI, all within the intuitive and flexible environment of Node-RED.
 
-## New in Version 0.4.0
-
-- Simplified file uploads.
-  - The `create file` function is now named `upload file` -- update your nodes accordingly.
-  - You no longer need to manually retrieve files in your flow using extra nodes (function, read file, etc.). The `upload file` function now accepts your desired file's absolute path as the `msg.payload.file` value.
-  - See the following updated examples (located in the `examples` directory) for more:
-    - Files
-    - Audio
-    - Images
-    - Assistants
-- Reliability improvements.
-- Now has full OpenAI Node.js package spec parity.
-- Bug fixes.
+## New in Version 0.6.0
+
+- The node now has a customizable input type field in the editor dialog.
+  - You can now configure your API call payload using either a `msg`, `flow`, or `global` property setting. This brings even greater contextual control to your AI requests.
+  - **Note:** Existing implementations default to `msg.payload` and _should_ continue to work as implemented using previous versions of this node.
+
+Please report any issues [here on Github](https://github.com/allanbunch/node-red-openai-api/issues).
 
 ## Key Features
 
@@ -100,21 +94,15 @@ I very much appreciate community input and invite everyone to shape the future o
 
 ### Engage in Various Discussions
 
-- **Announcements**: Stay updated with the latest project news.
-- **General**: Share thoughts or seek advice on broader topics.
-- **Ideas**: Propose new features or improvements.
-- **Polls**: Participate in polls to influence project decisions.
-- **Q&A**: Get answers to your questions and share your expertise.
-- **Show and Tell**: Showcase your creative implementations and inspire others.
+- **[Announcements](https://github.com/allanbunch/node-red-openai-api/discussions/categories/announcements)**: Stay updated with the latest project news.
+- **[General](https://github.com/allanbunch/node-red-openai-api/discussions/categories/general)**: Share thoughts or seek advice on broader topics.
+- **[Ideas](https://github.com/allanbunch/node-red-openai-api/discussions/categories/ideas)**: Propose new features or improvements.
+- **[Polls](https://github.com/allanbunch/node-red-openai-api/discussions/categories/polls)**: Participate in polls to influence project decisions.
+- **[Q&A](https://github.com/allanbunch/node-red-openai-api/discussions/categories/q-a)**: Get answers to your questions and share your expertise.
+- **[Show and Tell](https://github.com/allanbunch/node-red-openai-api/discussions/categories/show-and-tell)**: Showcase your creative implementations and inspire others.
 
 Join the conversation [here](https://github.com/allanbunch/node-red-openai-api/discussions) and let's build a vibrant and collaborative community together!
 
 ## License
 
 [MIT](./LICENSE)
-
-## Acknowledgements
-
-- [node-red-nodegen](https://github.com/node-red/node-red-nodegen)
-  - For boilerplate code generation, though the auto-generated code has been largely refactored.
-  - **Note:** This package uses `axios` in place of node-red-nodegen's `request` default.

package/lib.js

@@ -13,7 +13,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
 
       const openai = new OpenAI(clientParams);
       const response = await openai.chat.completions.create({
@@ -21,22 +21,29 @@ let OpenaiApi = (function () {
       });
 
       if (parameters.payload.stream) {
+        node.status({
+          fill: "green",
+          shape: "dot",
+          text: "OpenaiApi.status.streaming",
+        });
         for await (const chunk of response) {
-          node.send(chunk);
+          if (typeof chunk === "object") {
+            let payload = { payload: chunk };
+            node.send(payload);
+          }
         }
-        return { code: 0, status: "complete" };
+        node.status({});
       } else {
         return response;
       }
     }
 
     async createImage(parameters) {
-
       const clientParams = {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
 
       const openai = new OpenAI(clientParams);
       const response = await openai.images.generate({
@@ -51,7 +58,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       parameters.payload.image = fs.createReadStream(parameters.payload.image);
@@ -71,7 +78,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       parameters.payload.image = fs.createReadStream(parameters.payload.image);
@@ -87,7 +94,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.embeddings.create({
@@ -102,7 +109,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const audio = await openai.audio.speech.create({ ...parameters.payload });
@@ -116,7 +123,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       parameters.payload.file = fs.createReadStream(parameters.payload.file);
@@ -133,7 +140,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       parameters.payload.file = fs.createReadStream(parameters.payload.file);
@@ -149,7 +156,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const list = await openai.files.list({
@@ -169,7 +176,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       parameters.payload.file = fs.createReadStream(parameters.payload.file);
@@ -184,7 +191,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.files.del({
@@ -198,7 +205,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const file_id = parameters.payload.file_id;
@@ -215,7 +222,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const file_id = parameters.payload.file_id;
@@ -232,7 +239,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.fineTuning.jobs.create({
@@ -246,7 +253,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const list = await openai.fineTuning.jobs.list({
@@ -265,7 +272,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.fineTuning.jobs.retrieve(
@@ -279,7 +286,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       let response = [];
@@ -296,7 +303,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.fineTuning.jobs.cancel(
@@ -310,7 +317,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.models.list();
@@ -322,7 +329,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const model = parameters.payload.model;
@@ -335,7 +342,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const model = parameters.payload.model;
@@ -348,7 +355,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.moderations.create(parameters.payload);
@@ -359,7 +366,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.assistants.list({
@@ -373,7 +380,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.assistants.create({
@@ -387,7 +394,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.assistant_id;
@@ -400,7 +407,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.assistant_id;
@@ -417,7 +424,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.assistant_id;
@@ -430,7 +437,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.threads.create({
@@ -444,7 +451,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.thread_id;
@@ -457,7 +464,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.thread_id;
@@ -474,7 +481,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.thread_id;
@@ -487,7 +494,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const id = parameters.payload.thread_id;
@@ -500,7 +507,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -517,7 +524,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -535,7 +542,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -558,7 +565,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.threads.createAndRun({
@@ -572,7 +579,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thred_id = parameters.payload.thread_id;
@@ -589,7 +596,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -606,7 +613,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -626,7 +633,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -649,7 +656,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -672,7 +679,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -695,7 +702,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -718,7 +725,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -738,7 +745,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const assistant_id = parameters.payload.assistant_id;
@@ -755,7 +762,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const assistant_id = parameters.payload.assistant_id;
@@ -772,7 +779,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const assistant_id = parameters.payload.assistant_id;
@@ -795,7 +802,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const assistant_id = parameters.payload.assistant_id;
@@ -818,7 +825,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;
@@ -841,7 +848,7 @@ let OpenaiApi = (function () {
         apiKey: parameters.apiKey,
         baseURL: parameters.apiBase,
         organization: parameters.organization,
-      }
+      };
       const openai = new OpenAI(clientParams);
 
       const thread_id = parameters.payload.thread_id;

package/locales/de-DE/node.json

@@ -11,7 +11,8 @@
             "isQuery": "isQuery"
         },
         "status": {
-            "requesting": "requesting"
+            "requesting": "requesting",
+            "streaming": "streaming"
         },
         "parameters": {
             "createChatCompletion": "create chat completion",

package/locales/en-US/node.json

@@ -8,10 +8,12 @@
             "header": "Auth Header",
             "organizationId": "Org Id",
             "apiKey": "API Key",
-            "isQuery": "isQuery"
+            "isQuery": "isQuery",
+            "property": "Property"
         },
         "status": {
-            "requesting": "requesting"
+            "requesting": "requesting",
+            "streaming": "streaming"
         },
         "parameters": {
             "createChatCompletion": "create chat completion",

package/locales/zh-CN/node.json

@@ -11,7 +11,8 @@
             "isQuery": "isQuery"
         },
         "status": {
-            "requesting": "requesting"
+            "requesting": "requesting",
+            "streaming": "streaming"
         },
         "parameters": {
             "createChatCompletion": "create chat completion",

package/node.html

@@ -4,6 +4,8 @@
     color: "#B8B1FB",
     defaults: {
       name: { value: "" },
+      property: { value: "payload", required: true },
+      propertyType: { value: "msg" },
       service: { value: "", type: "Service Host", required: true },
       method: { value: "", required: true },
     },
@@ -22,8 +24,20 @@
         var methods = $("#node-input-method").children();
         var firstMethod = methods.first();
         $("#node-input-method").val(firstMethod.val());
+      };
+
+      // set the default property type value to "payload"
+      if (this.property === undefined) {
+        $("#node-input-property").val("payload");
       }
-    },
+
+      $("#node-input-property").typedInput({
+        default: "msg",
+        value: "payload",
+        types:["msg", "flow", "global"],
+        typeField: "#node-input-propertyType"
+      })
+    }
   });
 </script>
 
@@ -49,6 +63,15 @@
     <input type="text" id="node-input-service" />
   </div>
 
+  <div class="form-row">
+    <label for="node-input-property"
+      ><i class="fa fa-ellipsis-h"></i>
+      <span data-i18n="OpenaiApi.label.property"></span
+    ></label>
+    <input type="text" id="node-input-property">
+    <input type="hidden" id="node-input-propertyType">
+  </div>
+
   <div class="form-row">
     <label for="node-input-method"
       ><i class="fa fa-tasks"></i>
@@ -2681,7 +2704,7 @@
       );
       if (!selected.val()) {
         $("#node-config-input-secureApiKeyIsQuery").val(false);
-      }
+      };
     },
   });
 </script>

package/node.js

@@ -5,21 +5,32 @@ module.exports = function (RED) {
   class OpenaiApiNode {
     constructor(config) {
       RED.nodes.createNode(this, config);
-      this.service = RED.nodes.getNode(config.service);
-      this.method = config.method;
 
       let node = this;
+      node.service = RED.nodes.getNode(config.service);
+      node.config = config;
 
       node.on("input", function (msg) {
         let client = new lib.OpenaiApi();
+        let payload;
 
-        const serviceName = node.method; // Set the service name to call.
+        const propertyType = node.config.propertyType || "msg";
+        const propertyPath = node.config.property || "payload";
+
+        if (propertyType === "msg") {
+          payload = RED.util.getMessageProperty(msg, propertyPath);
+        } else {
+          // For flow and global contexts
+          payload = node.context()[propertyType].get(propertyPath);
+        }
+
+        const serviceName = node.config.method; // Set the service name to call.
         let serviceParametersObject = {
           organization: node.service.organizationId,
           apiBase: node.service.apiBase,
           apiKey: node.service.credentials.secureApiKeyValue || "",
           _node: node,
-          payload: { ...msg.payload },
+          payload: payload,
         };
 
         // Dynamically call the function based on the service name
@@ -33,10 +44,12 @@ module.exports = function (RED) {
 
           client[functionName](serviceParametersObject)
             .then((payload) => {
-              // Update `msg.payload` with the payload from the API response.
-              msg.payload = payload;
-              node.send(msg);
-              node.status({});
+              if (payload !== undefined) {
+                // Update `msg.payload` with the payload from the API response, then send resonse to client.
+                msg.payload = payload;
+                node.send(msg);
+                node.status({});
+              }
             })
             .catch(function (error) {
               node.status({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Go beyond ChatGPT and DALL·E 3: this Node-RED node seamlessly integrates a range of OpenAI services, including Assistants, Threads, Vision, and Audio, enabling feature-rich enhancement of your AI workflows with any OpenAI REST API-compatible solution.",
   "main": "node.js",
   "engines": {

package/.eslintrc.json

@@ -1,12 +0,0 @@
-{
-    "env": {
-        "commonjs": true,
-        "es2021": true,
-        "node": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": "latest"
-    },
-    "rules": {}
-}

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  "tabWidth": 2,
-  "useTabs": false
-}