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

package/locales/de-DE/node.json

@@ -6,6 +6,7 @@
             "method": "Method",
             "host": "Host",
             "header": "Auth Header",
+            "organizationId": "Org Id",
             "apiKey": "API Key",
             "isQuery": "isQuery"
         },
@@ -48,7 +49,7 @@
             "createTranslation": "create translation",
             "listFiles": "list files",
             "purpose": "purpose",
-            "createFile": "create file",
+            "uploadFile": "upload file",
             "deleteFile": "delete file",
             "file_id": "file_id",
             "retrieveFile": "retrieve file",

package/locales/en-US/node.json

@@ -49,7 +49,7 @@
             "createTranslation": "create translation",
             "listFiles": "list files",
             "purpose": "purpose",
-            "createFile": "create file",
+            "uploadFile": "upload file",
             "deleteFile": "delete file",
             "file_id": "file_id",
             "retrieveFile": "retrieve file",

package/locales/ja/node.json

@@ -6,6 +6,7 @@
             "method": "Method",
             "host": "Host",
             "header": "Auth Header",
+            "organizationId": "Org Id",
             "apiKey": "API Key",
             "isQuery": "isQuery"
         },
@@ -48,7 +49,7 @@
             "createTranslation": "create translation",
             "listFiles": "list files",
             "purpose": "purpose",
-            "createFile": "create file",
+            "uploadFile": "upload file",
             "deleteFile": "delete file",
             "file_id": "file_id",
             "retrieveFile": "retrieve file",

package/locales/zh-CN/node.json

@@ -6,6 +6,7 @@
             "method": "Method",
             "host": "Host",
             "header": "Auth Header",
+            "organizationId": "Org Id",
             "apiKey": "API Key",
             "isQuery": "isQuery"
         },
@@ -48,7 +49,7 @@
             "createTranslation": "create translation",
             "listFiles": "list files",
             "purpose": "purpose",
-            "createFile": "create file",
+            "uploadFile": "upload file",
             "deleteFile": "delete file",
             "file_id": "file_id",
             "retrieveFile": "retrieve file",

package/node.html

@@ -148,7 +148,7 @@
         ></option>
         <option
           value="createFile"
-          data-i18n="OpenaiApi.parameters.createFile"
+          data-i18n="OpenaiApi.parameters.uploadFile"
         ></option>
         <option
           value="deleteFile"
@@ -771,8 +771,7 @@
         <span class="property-type">file</span>
       </dt>
       <dd>
-        The audio file object (not file name) to transcribe, in one of these
-        formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
+        Absolute path to the file that's being transcribed, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
       </dd>
       <dt>
         model
@@ -847,8 +846,7 @@
         <span class="property-type">file</span>
       </dt>
       <dd>
-        The audio file object (not file name) translate, in one of these
-        formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
+        Absolute path to the file that's being translated, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
       </dd>
       <dt>
         model
@@ -1200,6 +1198,101 @@
     </dl>
   </section>
 
+  <section>
+    <h1 style="font-weight: bold;">📁 Files</h1>
+    <a
+      href="https://platform.openai.com/docs/api-reference/files"
+      target="_blank"
+      >Official Documentation
+      <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+    ></a>
+    <h2>List Files</h2>
+    <p>Returns a list of files that belong to the user's organization.</p>
+    <dl class="message-properties">
+      <h2>msg.payload Properties</h2>
+
+      <dt class="optional">
+        purpose
+        <a
+          href="https://platform.openai.com/docs/api-reference/files/list#files-list-purpose"
+          target="_blank"
+          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+        ></a>
+        <span class="property-type">string</span>
+      </dt>
+      <dd>Only return files with the given purpose.</dd>
+    </dl>
+
+    <h2>Upload File</h2>
+    <dl class="message-properties">
+      <h2>msg.payload Properties</h2>
+
+      <dt>
+        file
+        <a
+          href="https://platform.openai.com/docs/api-reference/files/create#files-create-file"
+          target="_blank"
+          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+        ></a>
+        <span class="property-type">file</span>
+      </dt>
+      <dd>Absolute path to the file that's being uploaded.</dd>
+      <dt>
+        purpose
+        <a
+          href="https://platform.openai.com/docs/api-reference/files/create#files-create-purpose"
+          target="_blank"
+          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+        ></a>
+        <span class="property-type">string</span>
+      </dt>
+      <dd>The intended purpose of the uploaded file.</dd>
+    </dl>
+
+    <h2>Delete File</h2>
+    <p>Delete a file.</p>
+    <dl class="message-properties">
+      <h2>msg.payload Properties</h2>
+
+      <dt>file_id <span class="property-type">string</span></dt>
+      <dd>The ID of the file to use for this request.</dd>
+    </dl>
+
+    <h2>Retrieve File</h2>
+    <p>Returns information about a specific file.</p>
+    <dl class="message-properties">
+      <h2>msg.payload Properties</h2>
+
+      <dt>
+        file_id
+        <a
+          href="https://platform.openai.com/docs/api-reference/files/delete#files-delete-file_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 file to use for this request.</dd>
+    </dl>
+
+    <h2>Retrieve File Content</h2>
+    <p>Returns the contents of the specified file.</p>
+    <dl class="message-properties">
+      <h2>msg.payload Properties</h2>
+
+      <dt>
+        file_id
+        <a
+          href="https://platform.openai.com/docs/api-reference/files/retrieve-contents#files-retrieve-contents-file_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 file to use for this request.</dd>
+    </dl>
+  </section>
+
   <section>
     <h1 style="font-weight: bold;">🔧 Fine-tuning</h1>
     <a
@@ -1373,101 +1466,6 @@
     </dl>
   </section>
 
-  <section>
-    <h1 style="font-weight: bold;">📁 Files</h1>
-    <a
-      href="https://platform.openai.com/docs/api-reference/files"
-      target="_blank"
-      >Official Documentation
-      <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
-    ></a>
-    <h2>List Files</h2>
-    <p>Returns a list of files that belong to the user's organization.</p>
-    <dl class="message-properties">
-      <h2>msg.payload Properties</h2>
-
-      <dt class="optional">
-        purpose
-        <a
-          href="https://platform.openai.com/docs/api-reference/files/list#files-list-purpose"
-          target="_blank"
-          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
-        ></a>
-        <span class="property-type">string</span>
-      </dt>
-      <dd>Only return files with the given purpose.</dd>
-    </dl>
-
-    <h2>Upload File</h2>
-    <dl class="message-properties">
-      <h2>msg.payload Properties</h2>
-
-      <dt>
-        file
-        <a
-          href="https://platform.openai.com/docs/api-reference/files/create#files-create-file"
-          target="_blank"
-          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
-        ></a>
-        <span class="property-type">file</span>
-      </dt>
-      <dd>The File object (not file name) to be uploaded.</dd>
-      <dt>
-        purpose
-        <a
-          href="https://platform.openai.com/docs/api-reference/files/create#files-create-purpose"
-          target="_blank"
-          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
-        ></a>
-        <span class="property-type">string</span>
-      </dt>
-      <dd>The intended purpose of the uploaded file.</dd>
-    </dl>
-
-    <h2>Delete File</h2>
-    <p>Delete a file.</p>
-    <dl class="message-properties">
-      <h2>msg.payload Properties</h2>
-
-      <dt>file_id <span class="property-type">string</span></dt>
-      <dd>The ID of the file to use for this request.</dd>
-    </dl>
-
-    <h2>Retrieve File</h2>
-    <p>Returns information about a specific file.</p>
-    <dl class="message-properties">
-      <h2>msg.payload Properties</h2>
-
-      <dt>
-        file_id
-        <a
-          href="https://platform.openai.com/docs/api-reference/files/delete#files-delete-file_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 file to use for this request.</dd>
-    </dl>
-
-    <h2>Retrieve File Content</h2>
-    <p>Returns the contents of the specified file.</p>
-    <dl class="message-properties">
-      <h2>msg.payload Properties</h2>
-
-      <dt>
-        file_id
-        <a
-          href="https://platform.openai.com/docs/api-reference/files/retrieve-contents#files-retrieve-contents-file_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 file to use for this request.</dd>
-    </dl>
-  </section>
-
   <section>
     <h1 style="font-weight: bold;">🖼️ Images</h1>
     <a

package/node.js

@@ -1,113 +1,76 @@
-'use strict';
-const lib = require('./lib.js');
+"use strict";
+const lib = require("./lib.js");
 
 module.exports = function (RED) {
-    class OpenaiApiNode {
-        constructor(config) {
-            RED.nodes.createNode(this, config);
-            this.service = RED.nodes.getNode(config.service);
-            this.method = config.method;
+  class OpenaiApiNode {
+    constructor(config) {
+      RED.nodes.createNode(this, config);
+      this.service = RED.nodes.getNode(config.service);
+      this.method = config.method;
 
-            let node = this;
+      let node = this;
 
-            node.on('input', function (msg) {
-                let errorFlag = false;
-                let client = new lib.OpenaiApi();
-                if (!errorFlag && this.service) {
-                    client.setApiBase(this.service.apiBase);
-                    client.setOrganizationIdHeader(this.service.organizationId);
-                }
+      node.on("input", function (msg) {
+        let client = new lib.OpenaiApi();
 
-                if (!errorFlag && this.service && this.service.credentials && this.service.credentials.secureApiKeyValue) {
-                    if (this.service.secureApiKeyIsQuery) {
-                        client.setApiKey(this.service.credentials.secureApiKeyValue,
-                            this.service.secureApiKeyHeaderOrQueryName, true);
-                    } else {
-                        client.setApiKey(this.service.credentials.secureApiKeyValue,
-                            this.service.secureApiKeyHeaderOrQueryName, false);
-                    }
-                }
+        const serviceName = node.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 },
+        };
 
-                if (!errorFlag){
-                    client.setNodeRef(node);
-                }
+        // Dynamically call the function based on the service name
+        const functionName = `${serviceName}`;
+        if (typeof client[functionName] === "function") {
+          node.status({
+            fill: "blue",
+            shape: "dot",
+            text: "OpenaiApi.status.requesting",
+          });
 
-                if (!errorFlag) {
-                    client.body = msg.payload;
-                }
-
-                let result;
-
-                if (!errorFlag) {
-                    const serviceName = node.method; // Specify the service you want to process
-                    let serviceParametersObject = {};
-
-                    // Dynamically call the function based on the service name
-                    const functionName = `${serviceName}`;
-                    if (typeof client[functionName] === 'function') {
-                        serviceParametersObject.body = msg.payload || {};
-                        result = client[functionName](serviceParametersObject);
-                    } else {
-                        console.error(`Function ${functionName} does not exist on client.`);
-                    }
-                }
-
-                if (!errorFlag && result === undefined) {
-                    node.error('Method is not specified.', msg);
-                    errorFlag = true;
-                }
-
-                let setData = function (msg, response) {
-                    if (response) {
-                        if (response.status) {
-                            msg.statusCode = response.status;
-                        }
-                        if (response.headers) {
-                            msg.headers = response.headers;
-                        }
-                        if (response.config && response.config.url) {
-                            msg.responseUrl = response.config.url;
-                        }
-                        if (response.data) {
-                            msg.payload = response.data;
-                        }
-                    }
-                    return msg;
-                };
-
-                if (!errorFlag) {
-                    node.status({ fill: 'blue', shape: 'dot', text: 'OpenaiApi.status.requesting' });
-                    result.then(function (response) {
-                        node.send(setData(msg, response));
-                        node.status({});
-                    }).catch(function (error) {
-                        let message = error.message;
-                        let errorData = error.response || {}; // Fallback to an empty object if response is not available
-                        node.error(message, setData(msg, errorData));
-                        node.status({ fill: 'red', shape: 'ring', text: 'node-red:common.status.error' });
-                    });
-                }
+          client[functionName](serviceParametersObject)
+            .then((payload) => {
+              // Update `msg.payload` with the payload from the API response.
+              msg.payload = payload;
+              node.send(msg);
+              node.status({});
+            })
+            .catch(function (error) {
+              node.status({
+                fill: "red",
+                shape: "ring",
+                text: "node-red:common.status.error",
+              });
+              let errorMessage = error.message;
+              node.error(errorMessage, { payload: {} });
             });
+        } else {
+          console.error(`Function ${functionName} does not exist on client.`);
         }
+      });
     }
+  }
 
-    RED.nodes.registerType('OpenAI API', OpenaiApiNode);
-    class ServiceHostNode {
-        constructor(n) {
-            RED.nodes.createNode(this, n);
+  RED.nodes.registerType("OpenAI API", OpenaiApiNode);
+  class ServiceHostNode {
+    constructor(n) {
+      RED.nodes.createNode(this, n);
 
-            this.secureApiKeyValue = n.secureApiKeyValue;
-            this.apiBase = n.apiBase;
-            this.secureApiKeyHeaderOrQueryName = n.secureApiKeyHeaderOrQueryName;
-            this.secureApiKeyIsQuery = n.secureApiKeyIsQuery;
-            this.organizationId = n.organizationId;
-        }
+      this.secureApiKeyValue = n.secureApiKeyValue;
+      this.apiBase = n.apiBase;
+      this.secureApiKeyHeaderOrQueryName = n.secureApiKeyHeaderOrQueryName;
+      this.secureApiKeyIsQuery = n.secureApiKeyIsQuery;
+      this.organizationId = n.organizationId;
     }
+  }
 
-    RED.nodes.registerType('Service Host', ServiceHostNode, {
-        credentials: {
-            secureApiKeyValue: { type: 'password' },
-            temp: { type: 'text' }
-        }
-    });
+  RED.nodes.registerType("Service Host", ServiceHostNode, {
+    credentials: {
+      secureApiKeyValue: { type: "password" },
+      temp: { type: "text" },
+    },
+  });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "0.3.9",
+  "version": "0.4.1",
   "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": {
@@ -27,8 +27,7 @@
     "ai"
   ],
   "dependencies": {
-    "axios": "^1.6.0",
-    "form-data": "^4.0.0"
+    "openai": "^4.26.1"
   },
   "devDependencies": {
     "eslint": "^8.54.0",